Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "generated/Endpoints"

Index

Interfaces

Type aliases

Type aliases

ActionsCancelWorkflowRunEndpoint

ActionsCancelWorkflowRunEndpoint: { owner: string; repo: string; run_id: number }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • run_id: number

    run_id parameter

ActionsCancelWorkflowRunRequestOptions

ActionsCancelWorkflowRunRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ActionsCreateOrUpdateSecretForRepoEndpoint

ActionsCreateOrUpdateSecretForRepoEndpoint: { encrypted_value?: string; key_id?: string; name: string; owner: string; repo: string }

Type declaration

  • Optional encrypted_value?: string

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get your public key endpoint.

  • Optional key_id?: string

    ID of the key you used to encrypt the secret.

  • name: string

    name parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ActionsCreateOrUpdateSecretForRepoRequestOptions

ActionsCreateOrUpdateSecretForRepoRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

ActionsCreateRegistrationTokenEndpoint

ActionsCreateRegistrationTokenEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ActionsCreateRegistrationTokenRequestOptions

ActionsCreateRegistrationTokenRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ActionsCreateRemoveTokenEndpoint

ActionsCreateRemoveTokenEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ActionsCreateRemoveTokenRequestOptions

ActionsCreateRemoveTokenRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ActionsDeleteArtifactEndpoint

ActionsDeleteArtifactEndpoint: { artifact_id: number; owner: string; repo: string }

Type declaration

  • artifact_id: number

    artifact_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ActionsDeleteArtifactRequestOptions

ActionsDeleteArtifactRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ActionsDeleteSecretFromRepoEndpoint

ActionsDeleteSecretFromRepoEndpoint: { name: string; owner: string; repo: string }

Type declaration

  • name: string

    name parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ActionsDeleteSecretFromRepoRequestOptions

ActionsDeleteSecretFromRepoRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ActionsDownloadArtifactEndpoint

ActionsDownloadArtifactEndpoint: { archive_format: string; artifact_id: number; owner: string; repo: string }

Type declaration

  • archive_format: string

    archive_format parameter

  • artifact_id: number

    artifact_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ActionsDownloadArtifactRequestOptions

ActionsDownloadArtifactRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActionsGetArtifactEndpoint

ActionsGetArtifactEndpoint: { artifact_id: number; owner: string; repo: string }

Type declaration

  • artifact_id: number

    artifact_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ActionsGetArtifactRequestOptions

ActionsGetArtifactRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActionsGetPublicKeyEndpoint

ActionsGetPublicKeyEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ActionsGetPublicKeyRequestOptions

ActionsGetPublicKeyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActionsGetSecretEndpoint

ActionsGetSecretEndpoint: { name: string; owner: string; repo: string }

Type declaration

  • name: string

    name parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ActionsGetSecretRequestOptions

ActionsGetSecretRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActionsGetSelfHostedRunnerEndpoint

ActionsGetSelfHostedRunnerEndpoint: { owner: string; repo: string; runner_id: number }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • runner_id: number

    runner_id parameter

ActionsGetSelfHostedRunnerRequestOptions

ActionsGetSelfHostedRunnerRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActionsGetWorkflowEndpoint

ActionsGetWorkflowEndpoint: { owner: string; repo: string; workflow_id: number }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • workflow_id: number

    workflow_id parameter

ActionsGetWorkflowJobEndpoint

ActionsGetWorkflowJobEndpoint: { job_id: number; owner: string; repo: string }

Type declaration

  • job_id: number

    job_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ActionsGetWorkflowJobRequestOptions

ActionsGetWorkflowJobRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActionsGetWorkflowRequestOptions

ActionsGetWorkflowRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActionsGetWorkflowRunEndpoint

ActionsGetWorkflowRunEndpoint: { owner: string; repo: string; run_id: number }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • run_id: number

    run_id parameter

ActionsGetWorkflowRunRequestOptions

ActionsGetWorkflowRunRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActionsListArtifactsForRepoEndpoint

ActionsListArtifactsForRepoEndpoint: { owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ActionsListArtifactsForRepoRequestOptions

ActionsListArtifactsForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActionsListDownloadsForSelfHostedRunnerApplicationEndpoint

ActionsListDownloadsForSelfHostedRunnerApplicationEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ActionsListDownloadsForSelfHostedRunnerApplicationRequestOptions

ActionsListDownloadsForSelfHostedRunnerApplicationRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActionsListJobsForWorkflowRunEndpoint

ActionsListJobsForWorkflowRunEndpoint: { filter?: "latest" | "all"; owner: string; page?: number; per_page?: number; repo: string; run_id: number }

Type declaration

  • Optional filter?: "latest" | "all"

    Filters jobs by their completed_at timestamp. Can be one of: * latest: Returns jobs from the most recent execution of the workflow run. * all: Returns all jobs for a workflow run, including from old executions of the workflow run.

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

  • run_id: number

    run_id parameter

ActionsListJobsForWorkflowRunRequestOptions

ActionsListJobsForWorkflowRunRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActionsListRepoWorkflowRunsEndpoint

ActionsListRepoWorkflowRunsEndpoint: { actor?: string; branch?: string; event?: string; owner: string; page?: number; per_page?: number; repo: string; status?: "completed" | "status" | "conclusion" }

Type declaration

  • Optional actor?: string

    Returns someone's workflow runs. Use the login for the user who created the push associated with the check suite or workflow run.

  • Optional branch?: string

    Returns workflow runs associated with a branch. Use the name of the branch of the push.

  • Optional event?: string

    Returns workflow run triggered by the event you specify. For example, push, pull_request or issue. For more information, see "Events that trigger workflows" in the GitHub Help documentation.

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

  • Optional status?: "completed" | "status" | "conclusion"

    Returns workflow runs associated with the check run status or conclusion you specify. For example, a conclusion can be success or a status can be completed. For more information, see the status and conclusion options available in "Create a check run."

ActionsListRepoWorkflowRunsRequestOptions

ActionsListRepoWorkflowRunsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActionsListRepoWorkflowsEndpoint

ActionsListRepoWorkflowsEndpoint: { owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ActionsListRepoWorkflowsRequestOptions

ActionsListRepoWorkflowsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActionsListSecretsForRepoEndpoint

ActionsListSecretsForRepoEndpoint: { owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ActionsListSecretsForRepoRequestOptions

ActionsListSecretsForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActionsListSelfHostedRunnersForRepoEndpoint

ActionsListSelfHostedRunnersForRepoEndpoint: { owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ActionsListSelfHostedRunnersForRepoRequestOptions

ActionsListSelfHostedRunnersForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActionsListWorkflowJobLogsEndpoint

ActionsListWorkflowJobLogsEndpoint: { job_id: number; owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • job_id: number

    job_id parameter

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ActionsListWorkflowJobLogsRequestOptions

ActionsListWorkflowJobLogsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActionsListWorkflowRunArtifactsEndpoint

ActionsListWorkflowRunArtifactsEndpoint: { owner: string; page?: number; per_page?: number; repo: string; run_id: number }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

  • run_id: number

    run_id parameter

ActionsListWorkflowRunArtifactsRequestOptions

ActionsListWorkflowRunArtifactsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActionsListWorkflowRunLogsEndpoint

ActionsListWorkflowRunLogsEndpoint: { owner: string; page?: number; per_page?: number; repo: string; run_id: number }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

  • run_id: number

    run_id parameter

ActionsListWorkflowRunLogsRequestOptions

ActionsListWorkflowRunLogsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActionsListWorkflowRunsEndpoint

ActionsListWorkflowRunsEndpoint: { actor?: string; branch?: string; event?: string; owner: string; page?: number; per_page?: number; repo: string; status?: "completed" | "status" | "conclusion"; workflow_id: number }

Type declaration

  • Optional actor?: string

    Returns someone's workflow runs. Use the login for the user who created the push associated with the check suite or workflow run.

  • Optional branch?: string

    Returns workflow runs associated with a branch. Use the name of the branch of the push.

  • Optional event?: string

    Returns workflow run triggered by the event you specify. For example, push, pull_request or issue. For more information, see "Events that trigger workflows" in the GitHub Help documentation.

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

  • Optional status?: "completed" | "status" | "conclusion"

    Returns workflow runs associated with the check run status or conclusion you specify. For example, a conclusion can be success or a status can be completed. For more information, see the status and conclusion options available in "Create a check run."

  • workflow_id: number

    workflow_id parameter

ActionsListWorkflowRunsRequestOptions

ActionsListWorkflowRunsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActionsReRunWorkflowEndpoint

ActionsReRunWorkflowEndpoint: { owner: string; repo: string; run_id: number }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • run_id: number

    run_id parameter

ActionsReRunWorkflowRequestOptions

ActionsReRunWorkflowRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ActionsRemoveSelfHostedRunnerEndpoint

ActionsRemoveSelfHostedRunnerEndpoint: { owner: string; repo: string; runner_id: number }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • runner_id: number

    runner_id parameter

ActionsRemoveSelfHostedRunnerRequestOptions

ActionsRemoveSelfHostedRunnerRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ActivityCheckRepoIsStarredByAuthenticatedUserEndpoint

ActivityCheckRepoIsStarredByAuthenticatedUserEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ActivityCheckRepoIsStarredByAuthenticatedUserRequestOptions

ActivityCheckRepoIsStarredByAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActivityCheckStarringRepoEndpoint

ActivityCheckStarringRepoEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ActivityCheckStarringRepoRequestOptions

ActivityCheckStarringRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActivityCheckWatchingRepoLegacyEndpoint

ActivityCheckWatchingRepoLegacyEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ActivityCheckWatchingRepoLegacyRequestOptions

ActivityCheckWatchingRepoLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActivityDeleteRepoSubscriptionEndpoint

ActivityDeleteRepoSubscriptionEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ActivityDeleteRepoSubscriptionRequestOptions

ActivityDeleteRepoSubscriptionRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ActivityDeleteThreadSubscriptionEndpoint

ActivityDeleteThreadSubscriptionEndpoint: { thread_id: number }

Type declaration

  • thread_id: number

    thread_id parameter

ActivityDeleteThreadSubscriptionRequestOptions

ActivityDeleteThreadSubscriptionRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ActivityGetFeedsEndpoint

ActivityGetFeedsEndpoint: {}

Type declaration

ActivityGetFeedsRequestOptions

ActivityGetFeedsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActivityGetRepoSubscriptionEndpoint

ActivityGetRepoSubscriptionEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ActivityGetRepoSubscriptionRequestOptions

ActivityGetRepoSubscriptionRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActivityGetThreadEndpoint

ActivityGetThreadEndpoint: { thread_id: number }

Type declaration

  • thread_id: number

    thread_id parameter

ActivityGetThreadRequestOptions

ActivityGetThreadRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActivityGetThreadSubscriptionEndpoint

ActivityGetThreadSubscriptionEndpoint: { last_read_at?: string }

Type declaration

  • Optional last_read_at?: string

    Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

ActivityGetThreadSubscriptionForAuthenticatedUserEndpoint

ActivityGetThreadSubscriptionForAuthenticatedUserEndpoint: { thread_id: number }

Type declaration

  • thread_id: number

    thread_id parameter

ActivityGetThreadSubscriptionForAuthenticatedUserRequestOptions

ActivityGetThreadSubscriptionForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActivityGetThreadSubscriptionRequestOptions

ActivityGetThreadSubscriptionRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

ActivityListEventsForAuthenticatedUserEndpoint

ActivityListEventsForAuthenticatedUserEndpoint: { page?: number; per_page?: number; username: string }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • username: string

    username parameter

ActivityListEventsForAuthenticatedUserRequestOptions

ActivityListEventsForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActivityListEventsForOrgEndpoint

ActivityListEventsForOrgEndpoint: { org: string; page?: number; per_page?: number; username: string }

Type declaration

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • username: string

    username parameter

ActivityListEventsForOrgRequestOptions

ActivityListEventsForOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActivityListEventsForUserEndpoint

ActivityListEventsForUserEndpoint: { page?: number; per_page?: number; username: string }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • username: string

    username parameter

ActivityListEventsForUserRequestOptions

ActivityListEventsForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActivityListFeedsEndpoint

ActivityListFeedsEndpoint: {}

Type declaration

ActivityListFeedsRequestOptions

ActivityListFeedsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActivityListNotificationsEndpoint

ActivityListNotificationsEndpoint: { all?: boolean; before?: string; page?: number; participating?: boolean; per_page?: number; since?: string }

Type declaration

  • Optional all?: boolean

    If true, show notifications marked as read.

  • Optional before?: string

    Only show notifications updated before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

  • Optional page?: number

    Page number of the results to fetch.

  • Optional participating?: boolean

    If true, only shows notifications in which the user is directly participating or mentioned.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional since?: string

    Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

ActivityListNotificationsForAuthenticatedUserEndpoint

ActivityListNotificationsForAuthenticatedUserEndpoint: { all?: boolean; before?: string; page?: number; participating?: boolean; per_page?: number; since?: string }

Type declaration

  • Optional all?: boolean

    If true, show notifications marked as read.

  • Optional before?: string

    Only show notifications updated before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

  • Optional page?: number

    Page number of the results to fetch.

  • Optional participating?: boolean

    If true, only shows notifications in which the user is directly participating or mentioned.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional since?: string

    Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

ActivityListNotificationsForAuthenticatedUserRequestOptions

ActivityListNotificationsForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActivityListNotificationsForRepoEndpoint

ActivityListNotificationsForRepoEndpoint: { all?: boolean; before?: string; owner: string; page?: number; participating?: boolean; per_page?: number; repo: string; since?: string }

Type declaration

  • Optional all?: boolean

    If true, show notifications marked as read.

  • Optional before?: string

    Only show notifications updated before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional participating?: boolean

    If true, only shows notifications in which the user is directly participating or mentioned.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

  • Optional since?: string

    Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

ActivityListNotificationsForRepoRequestOptions

ActivityListNotificationsForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActivityListNotificationsRequestOptions

ActivityListNotificationsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActivityListOrgEventsForAuthenticatedUserEndpoint

ActivityListOrgEventsForAuthenticatedUserEndpoint: { org: string; page?: number; per_page?: number; username: string }

Type declaration

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • username: string

    username parameter

ActivityListOrgEventsForAuthenticatedUserRequestOptions

ActivityListOrgEventsForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActivityListPublicEventsEndpoint

ActivityListPublicEventsEndpoint: { page?: number; per_page?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

ActivityListPublicEventsForOrgEndpoint

ActivityListPublicEventsForOrgEndpoint: { org: string; page?: number; per_page?: number }

Type declaration

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

ActivityListPublicEventsForOrgRequestOptions

ActivityListPublicEventsForOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActivityListPublicEventsForRepoNetworkEndpoint

ActivityListPublicEventsForRepoNetworkEndpoint: { owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ActivityListPublicEventsForRepoNetworkRequestOptions

ActivityListPublicEventsForRepoNetworkRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActivityListPublicEventsForUserEndpoint

ActivityListPublicEventsForUserEndpoint: { page?: number; per_page?: number; username: string }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • username: string

    username parameter

ActivityListPublicEventsForUserRequestOptions

ActivityListPublicEventsForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActivityListPublicEventsRequestOptions

ActivityListPublicEventsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActivityListPublicOrgEventsEndpoint

ActivityListPublicOrgEventsEndpoint: { org: string; page?: number; per_page?: number }

Type declaration

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

ActivityListPublicOrgEventsRequestOptions

ActivityListPublicOrgEventsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActivityListReceivedEventsForUserEndpoint

ActivityListReceivedEventsForUserEndpoint: { page?: number; per_page?: number; username: string }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • username: string

    username parameter

ActivityListReceivedEventsForUserRequestOptions

ActivityListReceivedEventsForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActivityListReceivedPublicEventsForUserEndpoint

ActivityListReceivedPublicEventsForUserEndpoint: { page?: number; per_page?: number; username: string }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • username: string

    username parameter

ActivityListReceivedPublicEventsForUserRequestOptions

ActivityListReceivedPublicEventsForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActivityListRepoEventsEndpoint

ActivityListRepoEventsEndpoint: { owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ActivityListRepoEventsRequestOptions

ActivityListRepoEventsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActivityListRepoNotificationsForAuthenticatedUserEndpoint

ActivityListRepoNotificationsForAuthenticatedUserEndpoint: { all?: boolean; before?: string; owner: string; page?: number; participating?: boolean; per_page?: number; repo: string; since?: string }

Type declaration

  • Optional all?: boolean

    If true, show notifications marked as read.

  • Optional before?: string

    Only show notifications updated before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional participating?: boolean

    If true, only shows notifications in which the user is directly participating or mentioned.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

  • Optional since?: string

    Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

ActivityListRepoNotificationsForAuthenticatedUserRequestOptions

ActivityListRepoNotificationsForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActivityListReposStarredByAuthenticatedUserEndpoint

ActivityListReposStarredByAuthenticatedUserEndpoint: { direction?: "asc" | "desc"; page?: number; per_page?: number; sort?: "created" | "updated" }

Type declaration

  • Optional direction?: "asc" | "desc"

    One of asc (ascending) or desc (descending).

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional sort?: "created" | "updated"

    One of created (when the repository was starred) or updated (when it was last pushed to).

ActivityListReposStarredByAuthenticatedUserRequestOptions

ActivityListReposStarredByAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActivityListReposStarredByUserEndpoint

ActivityListReposStarredByUserEndpoint: { direction?: "asc" | "desc"; page?: number; per_page?: number; sort?: "created" | "updated"; username: string }

Type declaration

  • Optional direction?: "asc" | "desc"

    One of asc (ascending) or desc (descending).

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional sort?: "created" | "updated"

    One of created (when the repository was starred) or updated (when it was last pushed to).

  • username: string

    username parameter

ActivityListReposStarredByUserRequestOptions

ActivityListReposStarredByUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActivityListReposWatchedByUserEndpoint

ActivityListReposWatchedByUserEndpoint: { page?: number; per_page?: number; username: string }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • username: string

    username parameter

ActivityListReposWatchedByUserRequestOptions

ActivityListReposWatchedByUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActivityListStargazersForRepoEndpoint

ActivityListStargazersForRepoEndpoint: { owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ActivityListStargazersForRepoRequestOptions

ActivityListStargazersForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActivityListWatchedReposForAuthenticatedUserEndpoint

ActivityListWatchedReposForAuthenticatedUserEndpoint: { page?: number; per_page?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

ActivityListWatchedReposForAuthenticatedUserRequestOptions

ActivityListWatchedReposForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActivityListWatchersForRepoEndpoint

ActivityListWatchersForRepoEndpoint: { owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ActivityListWatchersForRepoRequestOptions

ActivityListWatchersForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ActivityMarkAsReadEndpoint

ActivityMarkAsReadEndpoint: { last_read_at?: string }

Type declaration

  • Optional last_read_at?: string

    Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

ActivityMarkAsReadRequestOptions

ActivityMarkAsReadRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

ActivityMarkNotificationsAsReadEndpoint

ActivityMarkNotificationsAsReadEndpoint: { last_read_at?: string }

Type declaration

  • Optional last_read_at?: string

    Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

ActivityMarkNotificationsAsReadForRepoEndpoint

ActivityMarkNotificationsAsReadForRepoEndpoint: { last_read_at?: string; owner: string; repo: string }

Type declaration

  • Optional last_read_at?: string

    Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ActivityMarkNotificationsAsReadForRepoRequestOptions

ActivityMarkNotificationsAsReadForRepoRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

ActivityMarkNotificationsAsReadRequestOptions

ActivityMarkNotificationsAsReadRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

ActivityMarkRepoNotificationsAsReadEndpoint

ActivityMarkRepoNotificationsAsReadEndpoint: { last_read_at?: string; owner: string; repo: string }

Type declaration

  • Optional last_read_at?: string

    Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ActivityMarkRepoNotificationsAsReadRequestOptions

ActivityMarkRepoNotificationsAsReadRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

ActivityMarkThreadAsReadEndpoint

ActivityMarkThreadAsReadEndpoint: { thread_id: number }

Type declaration

  • thread_id: number

    thread_id parameter

ActivityMarkThreadAsReadRequestOptions

ActivityMarkThreadAsReadRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

ActivitySetRepoSubscriptionEndpoint

ActivitySetRepoSubscriptionEndpoint: { ignored?: boolean; owner: string; repo: string; subscribed?: boolean }

Type declaration

  • Optional ignored?: boolean

    Determines if all notifications should be blocked from this repository.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • Optional subscribed?: boolean

    Determines if notifications should be received from this repository.

ActivitySetRepoSubscriptionRequestOptions

ActivitySetRepoSubscriptionRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

ActivitySetThreadSubscriptionEndpoint

ActivitySetThreadSubscriptionEndpoint: { ignored?: boolean; thread_id: number }

Type declaration

  • Optional ignored?: boolean

    Unsubscribes and subscribes you to a conversation. Set ignored to true to block all notifications from this thread.

  • thread_id: number

    thread_id parameter

ActivitySetThreadSubscriptionRequestOptions

ActivitySetThreadSubscriptionRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

ActivityStarRepoEndpoint

ActivityStarRepoEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ActivityStarRepoForAuthenticatedUserEndpoint

ActivityStarRepoForAuthenticatedUserEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ActivityStarRepoForAuthenticatedUserRequestOptions

ActivityStarRepoForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

ActivityStarRepoRequestOptions

ActivityStarRepoRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

ActivityStopWatchingRepoLegacyEndpoint

ActivityStopWatchingRepoLegacyEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ActivityStopWatchingRepoLegacyRequestOptions

ActivityStopWatchingRepoLegacyRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ActivityUnstarRepoEndpoint

ActivityUnstarRepoEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ActivityUnstarRepoForAuthenticatedUserEndpoint

ActivityUnstarRepoForAuthenticatedUserEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ActivityUnstarRepoForAuthenticatedUserRequestOptions

ActivityUnstarRepoForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ActivityUnstarRepoRequestOptions

ActivityUnstarRepoRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ActivityWatchRepoLegacyEndpoint

ActivityWatchRepoLegacyEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ActivityWatchRepoLegacyRequestOptions

ActivityWatchRepoLegacyRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

AppsAddRepoToInstallationEndpoint

AppsAddRepoToInstallationEndpoint: { installation_id: number; repository_id: number }

Type declaration

  • installation_id: number

    installation_id parameter

  • repository_id: number

    repository_id parameter

AppsAddRepoToInstallationRequestOptions

AppsAddRepoToInstallationRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

AppsCheckAccountIsAssociatedWithAnyEndpoint

AppsCheckAccountIsAssociatedWithAnyEndpoint: { account_id: number }

Type declaration

  • account_id: number

    account_id parameter

AppsCheckAccountIsAssociatedWithAnyRequestOptions

AppsCheckAccountIsAssociatedWithAnyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

AppsCheckAccountIsAssociatedWithAnyStubbedEndpoint

AppsCheckAccountIsAssociatedWithAnyStubbedEndpoint: { account_id: number }

Type declaration

  • account_id: number

    account_id parameter

AppsCheckAccountIsAssociatedWithAnyStubbedRequestOptions

AppsCheckAccountIsAssociatedWithAnyStubbedRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

AppsCheckAuthorizationEndpoint

AppsCheckAuthorizationEndpoint: { access_token: string; client_id: string }

Type declaration

  • access_token: string

    access_token parameter

  • client_id: string

    client_id parameter

AppsCheckAuthorizationRequestOptions

AppsCheckAuthorizationRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

AppsCheckTokenEndpoint

AppsCheckTokenEndpoint: { access_token?: string; client_id: string }

Type declaration

  • Optional access_token?: string

    The OAuth access token used to authenticate to the GitHub API.

  • client_id: string

    client_id parameter

AppsCheckTokenRequestOptions

AppsCheckTokenRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

AppsCreateContentAttachmentEndpoint

AppsCreateContentAttachmentEndpoint: { body: string; content_reference_id: number; title: string }

Type declaration

  • body: string

    The body text of the content attachment displayed in the body or comment of an issue or pull request. This parameter supports markdown.

  • content_reference_id: number

    content_reference_id parameter

  • title: string

    The title of the content attachment displayed in the body or comment of an issue or pull request.

AppsCreateContentAttachmentRequestOptions

AppsCreateContentAttachmentRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

AppsCreateFromManifestEndpoint

AppsCreateFromManifestEndpoint: { code: string }

Type declaration

  • code: string

    code parameter

AppsCreateFromManifestRequestOptions

AppsCreateFromManifestRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

AppsCreateInstallationTokenEndpoint

AppsCreateInstallationTokenEndpoint: { installation_id: number; permissions?: AppsCreateInstallationTokenParamsPermissions; repository_ids?: number[] }

Type declaration

  • installation_id: number

    installation_id parameter

  • Optional permissions?: AppsCreateInstallationTokenParamsPermissions

    The permissions granted to the access token. The permissions object includes the permission names and their access type. For a complete list of permissions and allowable values, see "GitHub App permissions."

  • Optional repository_ids?: number[]

    The ids of the repositories that the installation token can access. Providing repository ids restricts the access of an installation token to specific repositories. You can use the "List repositories" endpoint to get the id of all repositories that an installation can access. For example, you can select specific repositories when creating an installation token to restrict the number of repositories that can be cloned using the token.

AppsCreateInstallationTokenParamsPermissions

AppsCreateInstallationTokenParamsPermissions: {}

Type declaration

AppsCreateInstallationTokenRequestOptions

AppsCreateInstallationTokenRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

AppsDeleteAuthorizationEndpoint

AppsDeleteAuthorizationEndpoint: { access_token?: string; client_id: string }

Type declaration

  • Optional access_token?: string

    The OAuth access token used to authenticate to the GitHub API.

  • client_id: string

    client_id parameter

AppsDeleteAuthorizationRequestOptions

AppsDeleteAuthorizationRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

AppsDeleteInstallationEndpoint

AppsDeleteInstallationEndpoint: { installation_id: number }

Type declaration

  • installation_id: number

    installation_id parameter

AppsDeleteInstallationRequestOptions

AppsDeleteInstallationRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

AppsDeleteTokenEndpoint

AppsDeleteTokenEndpoint: { access_token?: string; client_id: string }

Type declaration

  • Optional access_token?: string

    The OAuth access token used to authenticate to the GitHub API.

  • client_id: string

    client_id parameter

AppsDeleteTokenRequestOptions

AppsDeleteTokenRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

AppsFindOrgInstallationEndpoint

AppsFindOrgInstallationEndpoint: { org: string }

Type declaration

  • org: string

    org parameter

AppsFindOrgInstallationRequestOptions

AppsFindOrgInstallationRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

AppsFindRepoInstallationEndpoint

AppsFindRepoInstallationEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

AppsFindRepoInstallationRequestOptions

AppsFindRepoInstallationRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

AppsFindUserInstallationEndpoint

AppsFindUserInstallationEndpoint: { username: string }

Type declaration

  • username: string

    username parameter

AppsFindUserInstallationRequestOptions

AppsFindUserInstallationRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

AppsGetAuthenticatedEndpoint

AppsGetAuthenticatedEndpoint: {}

Type declaration

AppsGetAuthenticatedRequestOptions

AppsGetAuthenticatedRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

AppsGetBySlugEndpoint

AppsGetBySlugEndpoint: { app_slug: string }

Type declaration

  • app_slug: string

    app_slug parameter

AppsGetBySlugRequestOptions

AppsGetBySlugRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

AppsGetInstallationEndpoint

AppsGetInstallationEndpoint: { installation_id: number }

Type declaration

  • installation_id: number

    installation_id parameter

AppsGetInstallationRequestOptions

AppsGetInstallationRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

AppsGetOrgInstallationEndpoint

AppsGetOrgInstallationEndpoint: { org: string }

Type declaration

  • org: string

    org parameter

AppsGetOrgInstallationRequestOptions

AppsGetOrgInstallationRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

AppsGetRepoInstallationEndpoint

AppsGetRepoInstallationEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

AppsGetRepoInstallationRequestOptions

AppsGetRepoInstallationRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

AppsGetSubscriptionPlanForAccountEndpoint

AppsGetSubscriptionPlanForAccountEndpoint: { account_id: number }

Type declaration

  • account_id: number

    account_id parameter

AppsGetSubscriptionPlanForAccountRequestOptions

AppsGetSubscriptionPlanForAccountRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

AppsGetSubscriptionPlanForAccountStubbedEndpoint

AppsGetSubscriptionPlanForAccountStubbedEndpoint: { account_id: number }

Type declaration

  • account_id: number

    account_id parameter

AppsGetSubscriptionPlanForAccountStubbedRequestOptions

AppsGetSubscriptionPlanForAccountStubbedRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

AppsGetUserInstallationEndpoint

AppsGetUserInstallationEndpoint: { username: string }

Type declaration

  • username: string

    username parameter

AppsGetUserInstallationRequestOptions

AppsGetUserInstallationRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

AppsListAccountsForPlanEndpoint

AppsListAccountsForPlanEndpoint: { direction?: "asc" | "desc"; page?: number; per_page?: number; plan_id: number; sort?: "created" | "updated" }

Type declaration

  • Optional direction?: "asc" | "desc"

    To return the oldest accounts first, set to asc. Can be one of asc or desc. Ignored without the sort parameter.

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • plan_id: number

    plan_id parameter

  • Optional sort?: "created" | "updated"

    Sorts the GitHub accounts by the date they were created or last updated. Can be one of created or updated.

AppsListAccountsForPlanRequestOptions

AppsListAccountsForPlanRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

AppsListAccountsForPlanStubbedEndpoint

AppsListAccountsForPlanStubbedEndpoint: { direction?: "asc" | "desc"; page?: number; per_page?: number; plan_id: number; sort?: "created" | "updated" }

Type declaration

  • Optional direction?: "asc" | "desc"

    To return the oldest accounts first, set to asc. Can be one of asc or desc. Ignored without the sort parameter.

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • plan_id: number

    plan_id parameter

  • Optional sort?: "created" | "updated"

    Sorts the GitHub accounts by the date they were created or last updated. Can be one of created or updated.

AppsListAccountsForPlanStubbedRequestOptions

AppsListAccountsForPlanStubbedRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

AppsListAccountsUserOrOrgOnPlanEndpoint

AppsListAccountsUserOrOrgOnPlanEndpoint: { direction?: "asc" | "desc"; page?: number; per_page?: number; plan_id: number; sort?: "created" | "updated" }

Type declaration

  • Optional direction?: "asc" | "desc"

    To return the oldest accounts first, set to asc. Can be one of asc or desc. Ignored without the sort parameter.

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • plan_id: number

    plan_id parameter

  • Optional sort?: "created" | "updated"

    Sorts the GitHub accounts by the date they were created or last updated. Can be one of created or updated.

AppsListAccountsUserOrOrgOnPlanRequestOptions

AppsListAccountsUserOrOrgOnPlanRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

AppsListAccountsUserOrOrgOnPlanStubbedEndpoint

AppsListAccountsUserOrOrgOnPlanStubbedEndpoint: { direction?: "asc" | "desc"; page?: number; per_page?: number; plan_id: number; sort?: "created" | "updated" }

Type declaration

  • Optional direction?: "asc" | "desc"

    To return the oldest accounts first, set to asc. Can be one of asc or desc. Ignored without the sort parameter.

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • plan_id: number

    plan_id parameter

  • Optional sort?: "created" | "updated"

    Sorts the GitHub accounts by the date they were created or last updated. Can be one of created or updated.

AppsListAccountsUserOrOrgOnPlanStubbedRequestOptions

AppsListAccountsUserOrOrgOnPlanStubbedRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

AppsListInstallationReposForAuthenticatedUserEndpoint

AppsListInstallationReposForAuthenticatedUserEndpoint: { installation_id: number; page?: number; per_page?: number }

Type declaration

  • installation_id: number

    installation_id parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

AppsListInstallationReposForAuthenticatedUserRequestOptions

AppsListInstallationReposForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

AppsListInstallationsEndpoint

AppsListInstallationsEndpoint: { page?: number; per_page?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

AppsListInstallationsForAuthenticatedUserEndpoint

AppsListInstallationsForAuthenticatedUserEndpoint: { page?: number; per_page?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

AppsListInstallationsForAuthenticatedUserRequestOptions

AppsListInstallationsForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

AppsListInstallationsRequestOptions

AppsListInstallationsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

AppsListMarketplacePurchasesForAuthenticatedUserEndpoint

AppsListMarketplacePurchasesForAuthenticatedUserEndpoint: { page?: number; per_page?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

AppsListMarketplacePurchasesForAuthenticatedUserRequestOptions

AppsListMarketplacePurchasesForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

AppsListMarketplacePurchasesForAuthenticatedUserStubbedEndpoint

AppsListMarketplacePurchasesForAuthenticatedUserStubbedEndpoint: { page?: number; per_page?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

AppsListMarketplacePurchasesForAuthenticatedUserStubbedRequestOptions

AppsListMarketplacePurchasesForAuthenticatedUserStubbedRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

AppsListPlansEndpoint

AppsListPlansEndpoint: { page?: number; per_page?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

AppsListPlansRequestOptions

AppsListPlansRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

AppsListPlansStubbedEndpoint

AppsListPlansStubbedEndpoint: { page?: number; per_page?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

AppsListPlansStubbedRequestOptions

AppsListPlansStubbedRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

AppsListReposEndpoint

AppsListReposEndpoint: { page?: number; per_page?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

AppsListReposRequestOptions

AppsListReposRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

AppsListSubscriptionsForAuthenticatedUserEndpoint

AppsListSubscriptionsForAuthenticatedUserEndpoint: { page?: number; per_page?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

AppsListSubscriptionsForAuthenticatedUserRequestOptions

AppsListSubscriptionsForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

AppsListSubscriptionsForAuthenticatedUserStubbedEndpoint

AppsListSubscriptionsForAuthenticatedUserStubbedEndpoint: { page?: number; per_page?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

AppsListSubscriptionsForAuthenticatedUserStubbedRequestOptions

AppsListSubscriptionsForAuthenticatedUserStubbedRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

AppsRemoveRepoFromInstallationEndpoint

AppsRemoveRepoFromInstallationEndpoint: { installation_id: number; repository_id: number }

Type declaration

  • installation_id: number

    installation_id parameter

  • repository_id: number

    repository_id parameter

AppsRemoveRepoFromInstallationRequestOptions

AppsRemoveRepoFromInstallationRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

AppsResetAuthorizationEndpoint

AppsResetAuthorizationEndpoint: { access_token: string; client_id: string }

Type declaration

  • access_token: string

    access_token parameter

  • client_id: string

    client_id parameter

AppsResetAuthorizationRequestOptions

AppsResetAuthorizationRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

AppsResetTokenEndpoint

AppsResetTokenEndpoint: { access_token?: string; client_id: string }

Type declaration

  • Optional access_token?: string

    The OAuth access token used to authenticate to the GitHub API.

  • client_id: string

    client_id parameter

AppsResetTokenRequestOptions

AppsResetTokenRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

AppsRevokeAuthorizationForApplicationEndpoint

AppsRevokeAuthorizationForApplicationEndpoint: { access_token: string; client_id: string }

Type declaration

  • access_token: string

    access_token parameter

  • client_id: string

    client_id parameter

AppsRevokeAuthorizationForApplicationRequestOptions

AppsRevokeAuthorizationForApplicationRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

AppsRevokeGrantForApplicationEndpoint

AppsRevokeGrantForApplicationEndpoint: { access_token: string; client_id: string }

Type declaration

  • access_token: string

    access_token parameter

  • client_id: string

    client_id parameter

AppsRevokeGrantForApplicationRequestOptions

AppsRevokeGrantForApplicationRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

AppsRevokeInstallationTokenEndpoint

AppsRevokeInstallationTokenEndpoint: {}

Type declaration

AppsRevokeInstallationTokenRequestOptions

AppsRevokeInstallationTokenRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ChecksCreateEndpoint

ChecksCreateEndpoint: { actions?: ChecksCreateParamsActions[]; completed_at?: string; conclusion?: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required"; details_url?: string; external_id?: string; head_sha: string; name: string; output?: ChecksCreateParamsOutput; owner: string; repo: string; started_at?: string; status?: "queued" | "in_progress" | "completed" }

Type declaration

  • Optional actions?: ChecksCreateParamsActions[]

    Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the check_run.requested_action webhook to your app. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see "Check runs and requested actions." To learn more about check runs and requested actions, see "Check runs and requested actions."

  • Optional completed_at?: string

    The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

  • Optional conclusion?: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required"

    Required if you provide completed_at or a status of completed. The final conclusion of the check. Can be one of success, failure, neutral, cancelled, timed_out, or action_required. When the conclusion is action_required, additional details should be provided on the site specified by details_url. Note: Providing conclusion will automatically set the status parameter to completed. Only GitHub can change a check run conclusion to stale.

  • Optional details_url?: string

    The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used.

  • Optional external_id?: string

    A reference for the run on the integrator's system.

  • head_sha: string

    The SHA of the commit.

  • name: string

    The name of the check. For example, "code-coverage".

  • Optional output?: ChecksCreateParamsOutput

    Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run. See the output object description.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • Optional started_at?: string

    The time that the check run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

  • Optional status?: "queued" | "in_progress" | "completed"

    The current status. Can be one of queued, in_progress, or completed.

ChecksCreateParamsActions

ChecksCreateParamsActions: { description: string; identifier: string; label: string }

Type declaration

  • description: string
  • identifier: string
  • label: string

ChecksCreateParamsOutput

ChecksCreateParamsOutput: { annotations?: ChecksCreateParamsOutputAnnotations[]; images?: ChecksCreateParamsOutputImages[]; summary: string; text?: string; title: string }

Type declaration

ChecksCreateParamsOutputAnnotations

ChecksCreateParamsOutputAnnotations: { annotation_level: "notice" | "warning" | "failure"; end_column?: number; end_line: number; message: string; path: string; raw_details?: string; start_column?: number; start_line: number; title?: string }

Type declaration

  • annotation_level: "notice" | "warning" | "failure"
  • Optional end_column?: number
  • end_line: number
  • message: string
  • path: string
  • Optional raw_details?: string
  • Optional start_column?: number
  • start_line: number
  • Optional title?: string

ChecksCreateParamsOutputImages

ChecksCreateParamsOutputImages: { alt: string; caption?: string; image_url: string }

Type declaration

  • alt: string
  • Optional caption?: string
  • image_url: string

ChecksCreateRequestOptions

ChecksCreateRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ChecksCreateSuiteEndpoint

ChecksCreateSuiteEndpoint: { head_sha: string; owner: string; repo: string }

Type declaration

  • head_sha: string

    The sha of the head commit.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ChecksCreateSuiteRequestOptions

ChecksCreateSuiteRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ChecksGetEndpoint

ChecksGetEndpoint: { check_run_id: number; owner: string; repo: string }

Type declaration

  • check_run_id: number

    check_run_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ChecksGetRequestOptions

ChecksGetRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ChecksGetSuiteEndpoint

ChecksGetSuiteEndpoint: { check_suite_id: number; owner: string; repo: string }

Type declaration

  • check_suite_id: number

    check_suite_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ChecksGetSuiteRequestOptions

ChecksGetSuiteRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ChecksListAnnotationsEndpoint

ChecksListAnnotationsEndpoint: { check_run_id: number; owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • check_run_id: number

    check_run_id parameter

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ChecksListAnnotationsRequestOptions

ChecksListAnnotationsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ChecksListForRefEndpoint

ChecksListForRefEndpoint: { check_name?: string; filter?: "latest" | "all"; owner: string; page?: number; per_page?: number; ref: string; repo: string; status?: "queued" | "in_progress" | "completed" }

Type declaration

  • Optional check_name?: string

    Returns check runs with the specified name.

  • Optional filter?: "latest" | "all"

    Filters check runs by their completed_at timestamp. Can be one of latest (returning the most recent check runs) or all.

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • ref: string

    ref parameter

  • repo: string

    repo parameter

  • Optional status?: "queued" | "in_progress" | "completed"

    Returns check runs with the specified status. Can be one of queued, in_progress, or completed.

ChecksListForRefRequestOptions

ChecksListForRefRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ChecksListForSuiteEndpoint

ChecksListForSuiteEndpoint: { check_name?: string; check_suite_id: number; filter?: "latest" | "all"; owner: string; page?: number; per_page?: number; repo: string; status?: "queued" | "in_progress" | "completed" }

Type declaration

  • Optional check_name?: string

    Returns check runs with the specified name.

  • check_suite_id: number

    check_suite_id parameter

  • Optional filter?: "latest" | "all"

    Filters check runs by their completed_at timestamp. Can be one of latest (returning the most recent check runs) or all.

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

  • Optional status?: "queued" | "in_progress" | "completed"

    Returns check runs with the specified status. Can be one of queued, in_progress, or completed.

ChecksListForSuiteRequestOptions

ChecksListForSuiteRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ChecksListSuitesForRefEndpoint

ChecksListSuitesForRefEndpoint: { app_id?: number; check_name?: string; owner: string; page?: number; per_page?: number; ref: string; repo: string }

Type declaration

  • Optional app_id?: number

    Filters check suites by GitHub App id.

  • Optional check_name?: string

    Filters checks suites by the name of the check run.

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • ref: string

    ref parameter

  • repo: string

    repo parameter

ChecksListSuitesForRefRequestOptions

ChecksListSuitesForRefRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ChecksRerequestSuiteEndpoint

ChecksRerequestSuiteEndpoint: { check_suite_id: number; owner: string; repo: string }

Type declaration

  • check_suite_id: number

    check_suite_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ChecksRerequestSuiteRequestOptions

ChecksRerequestSuiteRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ChecksSetSuitesPreferencesEndpoint

ChecksSetSuitesPreferencesEndpoint: { auto_trigger_checks?: ChecksSetSuitesPreferencesParamsAutoTriggerChecks[]; owner: string; repo: string }

Type declaration

ChecksSetSuitesPreferencesParamsAutoTriggerChecks

ChecksSetSuitesPreferencesParamsAutoTriggerChecks: { app_id: number; setting: boolean }

Type declaration

  • app_id: number
  • setting: boolean

ChecksSetSuitesPreferencesRequestOptions

ChecksSetSuitesPreferencesRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

ChecksUpdateEndpoint

ChecksUpdateEndpoint: { actions?: ChecksUpdateParamsActions[]; check_run_id: number; completed_at?: string; conclusion?: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required"; details_url?: string; external_id?: string; name?: string; output?: ChecksUpdateParamsOutput; owner: string; repo: string; started_at?: string; status?: "queued" | "in_progress" | "completed" }

Type declaration

  • Optional actions?: ChecksUpdateParamsActions[]

    Possible further actions the integrator can perform, which a user may trigger. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. To learn more about check runs and requested actions, see "Check runs and requested actions."

  • check_run_id: number

    check_run_id parameter

  • Optional completed_at?: string

    The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

  • Optional conclusion?: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required"

    Required if you provide completed_at or a status of completed. The final conclusion of the check. Can be one of success, failure, neutral, cancelled, timed_out, or action_required. Note: Providing conclusion will automatically set the status parameter to completed. Only GitHub can change a check run conclusion to stale.

  • Optional details_url?: string

    The URL of the integrator's site that has the full details of the check.

  • Optional external_id?: string

    A reference for the run on the integrator's system.

  • Optional name?: string

    The name of the check. For example, "code-coverage".

  • Optional output?: ChecksUpdateParamsOutput

    Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run. See the output object description.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • Optional started_at?: string

    This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

  • Optional status?: "queued" | "in_progress" | "completed"

    The current status. Can be one of queued, in_progress, or completed.

ChecksUpdateParamsActions

ChecksUpdateParamsActions: { description: string; identifier: string; label: string }

Type declaration

  • description: string
  • identifier: string
  • label: string

ChecksUpdateParamsOutput

ChecksUpdateParamsOutput: { annotations?: ChecksUpdateParamsOutputAnnotations[]; images?: ChecksUpdateParamsOutputImages[]; summary: string; text?: string; title?: string }

Type declaration

ChecksUpdateParamsOutputAnnotations

ChecksUpdateParamsOutputAnnotations: { annotation_level: "notice" | "warning" | "failure"; end_column?: number; end_line: number; message: string; path: string; raw_details?: string; start_column?: number; start_line: number; title?: string }

Type declaration

  • annotation_level: "notice" | "warning" | "failure"
  • Optional end_column?: number
  • end_line: number
  • message: string
  • path: string
  • Optional raw_details?: string
  • Optional start_column?: number
  • start_line: number
  • Optional title?: string

ChecksUpdateParamsOutputImages

ChecksUpdateParamsOutputImages: { alt: string; caption?: string; image_url: string }

Type declaration

  • alt: string
  • Optional caption?: string
  • image_url: string

ChecksUpdateRequestOptions

ChecksUpdateRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

CodesOfConductGetAllCodesOfConductEndpoint

CodesOfConductGetAllCodesOfConductEndpoint: {}

Type declaration

CodesOfConductGetAllCodesOfConductRequestOptions

CodesOfConductGetAllCodesOfConductRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

CodesOfConductGetConductCodeEndpoint

CodesOfConductGetConductCodeEndpoint: { key: string }

Type declaration

  • key: string

    key parameter

CodesOfConductGetConductCodeRequestOptions

CodesOfConductGetConductCodeRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

CodesOfConductGetForRepoEndpoint

CodesOfConductGetForRepoEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

CodesOfConductGetForRepoRequestOptions

CodesOfConductGetForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

CodesOfConductListConductCodesEndpoint

CodesOfConductListConductCodesEndpoint: {}

Type declaration

CodesOfConductListConductCodesRequestOptions

CodesOfConductListConductCodesRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

EmojisGetEndpoint

EmojisGetEndpoint: {}

Type declaration

EmojisGetRequestOptions

EmojisGetRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

GistsCheckIsStarredEndpoint

GistsCheckIsStarredEndpoint: { gist_id: string }

Type declaration

  • gist_id: string

    gist_id parameter

GistsCheckIsStarredRequestOptions

GistsCheckIsStarredRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

GistsCreateCommentEndpoint

GistsCreateCommentEndpoint: { body: string; gist_id: string }

Type declaration

  • body: string

    The comment text.

  • gist_id: string

    gist_id parameter

GistsCreateCommentRequestOptions

GistsCreateCommentRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

GistsCreateEndpoint

GistsCreateEndpoint: { description?: string; files: GistsCreateParamsFiles; public?: boolean }

Type declaration

  • Optional description?: string

    A descriptive name for this gist.

  • files: GistsCreateParamsFiles

    The filenames and content of each file in the gist. The keys in the files object represent the filename and have the type string.

  • Optional public?: boolean

    When true, the gist will be public and available for anyone to see.

GistsCreateParamsFiles

GistsCreateParamsFiles: { content?: string }

Type declaration

  • Optional content?: string

GistsCreateRequestOptions

GistsCreateRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

GistsDeleteCommentEndpoint

GistsDeleteCommentEndpoint: { comment_id: number; gist_id: string }

Type declaration

  • comment_id: number

    comment_id parameter

  • gist_id: string

    gist_id parameter

GistsDeleteCommentRequestOptions

GistsDeleteCommentRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

GistsDeleteEndpoint

GistsDeleteEndpoint: { gist_id: string }

Type declaration

  • gist_id: string

    gist_id parameter

GistsDeleteRequestOptions

GistsDeleteRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

GistsForkEndpoint

GistsForkEndpoint: { gist_id: string }

Type declaration

  • gist_id: string

    gist_id parameter

GistsForkRequestOptions

GistsForkRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

GistsGetCommentEndpoint

GistsGetCommentEndpoint: { comment_id: number; gist_id: string }

Type declaration

  • comment_id: number

    comment_id parameter

  • gist_id: string

    gist_id parameter

GistsGetCommentRequestOptions

GistsGetCommentRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

GistsGetEndpoint

GistsGetEndpoint: { gist_id: string }

Type declaration

  • gist_id: string

    gist_id parameter

GistsGetRequestOptions

GistsGetRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

GistsGetRevisionEndpoint

GistsGetRevisionEndpoint: { gist_id: string; sha: string }

Type declaration

  • gist_id: string

    gist_id parameter

  • sha: string

    sha parameter

GistsGetRevisionRequestOptions

GistsGetRevisionRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

GistsListCommentsEndpoint

GistsListCommentsEndpoint: { gist_id: string; page?: number; per_page?: number }

Type declaration

  • gist_id: string

    gist_id parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

GistsListCommentsRequestOptions

GistsListCommentsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

GistsListCommitsEndpoint

GistsListCommitsEndpoint: { gist_id: string; page?: number; per_page?: number }

Type declaration

  • gist_id: string

    gist_id parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

GistsListCommitsRequestOptions

GistsListCommitsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

GistsListEndpoint

GistsListEndpoint: { page?: number; per_page?: number; since?: string }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional since?: string

    This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only gists updated at or after this time are returned.

GistsListForUserEndpoint

GistsListForUserEndpoint: { page?: number; per_page?: number; since?: string; username: string }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional since?: string

    This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only gists updated at or after this time are returned.

  • username: string

    username parameter

GistsListForUserRequestOptions

GistsListForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

GistsListForksEndpoint

GistsListForksEndpoint: { gist_id: string; page?: number; per_page?: number }

Type declaration

  • gist_id: string

    gist_id parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

GistsListForksRequestOptions

GistsListForksRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

GistsListPublicEndpoint

GistsListPublicEndpoint: { page?: number; per_page?: number; since?: string }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional since?: string

    This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only gists updated at or after this time are returned.

GistsListPublicForUserEndpoint

GistsListPublicForUserEndpoint: { page?: number; per_page?: number; since?: string; username: string }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional since?: string

    This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only gists updated at or after this time are returned.

  • username: string

    username parameter

GistsListPublicForUserRequestOptions

GistsListPublicForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

GistsListPublicRequestOptions

GistsListPublicRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

GistsListRequestOptions

GistsListRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

GistsListStarredEndpoint

GistsListStarredEndpoint: { page?: number; per_page?: number; since?: string }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional since?: string

    This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only gists updated at or after this time are returned.

GistsListStarredRequestOptions

GistsListStarredRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

GistsStarEndpoint

GistsStarEndpoint: { gist_id: string }

Type declaration

  • gist_id: string

    gist_id parameter

GistsStarRequestOptions

GistsStarRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

GistsUnstarEndpoint

GistsUnstarEndpoint: { gist_id: string }

Type declaration

  • gist_id: string

    gist_id parameter

GistsUnstarRequestOptions

GistsUnstarRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

GistsUpdateCommentEndpoint

GistsUpdateCommentEndpoint: { body: string; comment_id: number; gist_id: string }

Type declaration

  • body: string

    The comment text.

  • comment_id: number

    comment_id parameter

  • gist_id: string

    gist_id parameter

GistsUpdateCommentRequestOptions

GistsUpdateCommentRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

GistsUpdateEndpoint

GistsUpdateEndpoint: { description?: string; files?: GistsUpdateParamsFiles; gist_id: string }

Type declaration

  • Optional description?: string

    A descriptive name for this gist.

  • Optional files?: GistsUpdateParamsFiles

    The filenames and content that make up this gist.

  • gist_id: string

    gist_id parameter

GistsUpdateParamsFiles

GistsUpdateParamsFiles: { content?: string; filename?: string }

Type declaration

  • Optional content?: string
  • Optional filename?: string

GistsUpdateRequestOptions

GistsUpdateRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

GitCreateBlobEndpoint

GitCreateBlobEndpoint: { content: string; encoding?: string; owner: string; repo: string }

Type declaration

  • content: string

    The new blob's content.

  • Optional encoding?: string

    The encoding used for content. Currently, "utf-8" and "base64" are supported.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

GitCreateBlobRequestOptions

GitCreateBlobRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

GitCreateCommitEndpoint

GitCreateCommitEndpoint: { author?: GitCreateCommitParamsAuthor; committer?: GitCreateCommitParamsCommitter; message: string; owner: string; parents: string[]; repo: string; signature?: string; tree: string }

Type declaration

  • Optional author?: GitCreateCommitParamsAuthor

    Information about the author of the commit. By default, the author will be the authenticated user and the current date. See the author and committer object below for details.

  • Optional committer?: GitCreateCommitParamsCommitter

    Information about the person who is making the commit. By default, committer will use the information set in author. See the author and committer object below for details.

  • message: string

    The commit message

  • owner: string

    owner parameter

  • parents: string[]

    The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.

  • repo: string

    repo parameter

  • Optional signature?: string

    The PGP signature of the commit. GitHub adds the signature to the gpgsig header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a signature parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to use the command line to create signed commits.

  • tree: string

    The SHA of the tree object this commit points to

GitCreateCommitParamsAuthor

GitCreateCommitParamsAuthor: { date?: string; email?: string; name?: string }

Type declaration

  • Optional date?: string
  • Optional email?: string
  • Optional name?: string

GitCreateCommitParamsCommitter

GitCreateCommitParamsCommitter: { date?: string; email?: string; name?: string }

Type declaration

  • Optional date?: string
  • Optional email?: string
  • Optional name?: string

GitCreateCommitRequestOptions

GitCreateCommitRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

GitCreateRefEndpoint

GitCreateRefEndpoint: { owner: string; ref: string; repo: string; sha: string }

Type declaration

  • owner: string

    owner parameter

  • ref: string

    The name of the fully qualified reference (ie: refs/heads/master). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.

  • repo: string

    repo parameter

  • sha: string

    The SHA1 value for this reference.

GitCreateRefRequestOptions

GitCreateRefRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

GitCreateTagEndpoint

GitCreateTagEndpoint: { message: string; object: string; owner: string; repo: string; tag: string; tagger?: GitCreateTagParamsTagger; type: "commit" | "tree" | "blob" }

Type declaration

  • message: string

    The tag message.

  • object: string

    The SHA of the git object this is tagging.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • tag: string

    The tag's name. This is typically a version (e.g., "v0.0.1").

  • Optional tagger?: GitCreateTagParamsTagger

    An object with information about the individual creating the tag.

  • type: "commit" | "tree" | "blob"

    The type of the object we're tagging. Normally this is a commit but it can also be a tree or a blob.

GitCreateTagParamsTagger

GitCreateTagParamsTagger: { date?: string; email?: string; name?: string }

Type declaration

  • Optional date?: string
  • Optional email?: string
  • Optional name?: string

GitCreateTagRequestOptions

GitCreateTagRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

GitCreateTreeEndpoint

GitCreateTreeEndpoint: { base_tree?: string; owner: string; repo: string; tree: GitCreateTreeParamsTree[] }

Type declaration

  • Optional base_tree?: string

    The SHA1 of the tree you want to update with new data. If you don't set this, the commit will be created on top of everything; however, it will only contain your change, the rest of your files will show up as deleted.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • tree: GitCreateTreeParamsTree[]

    Objects (of path, mode, type, and sha) specifying a tree structure.

GitCreateTreeParamsTree

GitCreateTreeParamsTree: { content?: string; mode?: "100644" | "100755" | "040000" | "160000" | "120000"; path?: string; sha?: string | null; type?: "blob" | "tree" | "commit" }

Type declaration

  • Optional content?: string
  • Optional mode?: "100644" | "100755" | "040000" | "160000" | "120000"
  • Optional path?: string
  • Optional sha?: string | null
  • Optional type?: "blob" | "tree" | "commit"

GitCreateTreeRequestOptions

GitCreateTreeRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

GitDeleteRefEndpoint

GitDeleteRefEndpoint: { owner: string; ref: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • ref: string

    ref parameter

  • repo: string

    repo parameter

GitDeleteRefRequestOptions

GitDeleteRefRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

GitGetBlobEndpoint

GitGetBlobEndpoint: { file_sha: string; owner: string; repo: string }

Type declaration

  • file_sha: string

    file_sha parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

GitGetBlobRequestOptions

GitGetBlobRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

GitGetCommitEndpoint

GitGetCommitEndpoint: { commit_sha: string; owner: string; repo: string }

Type declaration

  • commit_sha: string

    commit_sha parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

GitGetCommitRequestOptions

GitGetCommitRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

GitGetRefEndpoint

GitGetRefEndpoint: { owner: string; ref: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • ref: string

    ref parameter

  • repo: string

    repo parameter

GitGetRefRequestOptions

GitGetRefRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

GitGetTagEndpoint

GitGetTagEndpoint: { owner: string; repo: string; tag_sha: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • tag_sha: string

    tag_sha parameter

GitGetTagRequestOptions

GitGetTagRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

GitGetTreeEndpoint

GitGetTreeEndpoint: { owner: string; recursive?: "1"; repo: string; tree_sha: string }

Type declaration

  • owner: string

    owner parameter

  • Optional recursive?: "1"

    recursive parameter

  • repo: string

    repo parameter

  • tree_sha: string

    tree_sha parameter

GitGetTreeRequestOptions

GitGetTreeRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

GitListMatchingRefsEndpoint

GitListMatchingRefsEndpoint: { owner: string; page?: number; per_page?: number; ref: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • ref: string

    ref parameter

  • repo: string

    repo parameter

GitListMatchingRefsRequestOptions

GitListMatchingRefsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

GitUpdateRefEndpoint

GitUpdateRefEndpoint: { force?: boolean; owner: string; ref: string; repo: string; sha: string }

Type declaration

  • Optional force?: boolean

    Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to false will make sure you're not overwriting work.

  • owner: string

    owner parameter

  • ref: string

    ref parameter

  • repo: string

    repo parameter

  • sha: string

    The SHA1 value to set this reference to

GitUpdateRefRequestOptions

GitUpdateRefRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

GitignoreGetTemplateEndpoint

GitignoreGetTemplateEndpoint: { name: string }

Type declaration

  • name: string

    name parameter

GitignoreGetTemplateRequestOptions

GitignoreGetTemplateRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

GitignoreListTemplatesEndpoint

GitignoreListTemplatesEndpoint: {}

Type declaration

GitignoreListTemplatesRequestOptions

GitignoreListTemplatesRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

InteractionsAddOrUpdateRestrictionsForOrgEndpoint

InteractionsAddOrUpdateRestrictionsForOrgEndpoint: { limit: "existing_users" | "contributors_only" | "collaborators_only"; org: string }

Type declaration

  • limit: "existing_users" | "contributors_only" | "collaborators_only"

    Specifies the group of GitHub users who can comment, open issues, or create pull requests in public repositories for the given organization. Must be one of: existing_users, contributors_only, or collaborators_only.

  • org: string

    org parameter

InteractionsAddOrUpdateRestrictionsForOrgRequestOptions

InteractionsAddOrUpdateRestrictionsForOrgRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

InteractionsAddOrUpdateRestrictionsForRepoEndpoint

InteractionsAddOrUpdateRestrictionsForRepoEndpoint: { limit: "existing_users" | "contributors_only" | "collaborators_only"; owner: string; repo: string }

Type declaration

  • limit: "existing_users" | "contributors_only" | "collaborators_only"

    Specifies the group of GitHub users who can comment, open issues, or create pull requests for the given repository. Must be one of: existing_users, contributors_only, or collaborators_only.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

InteractionsAddOrUpdateRestrictionsForRepoRequestOptions

InteractionsAddOrUpdateRestrictionsForRepoRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

InteractionsGetRestrictionsForOrgEndpoint

InteractionsGetRestrictionsForOrgEndpoint: { org: string }

Type declaration

  • org: string

    org parameter

InteractionsGetRestrictionsForOrgRequestOptions

InteractionsGetRestrictionsForOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

InteractionsGetRestrictionsForRepoEndpoint

InteractionsGetRestrictionsForRepoEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

InteractionsGetRestrictionsForRepoRequestOptions

InteractionsGetRestrictionsForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

InteractionsRemoveRestrictionsForOrgEndpoint

InteractionsRemoveRestrictionsForOrgEndpoint: { org: string }

Type declaration

  • org: string

    org parameter

InteractionsRemoveRestrictionsForOrgRequestOptions

InteractionsRemoveRestrictionsForOrgRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

InteractionsRemoveRestrictionsForRepoEndpoint

InteractionsRemoveRestrictionsForRepoEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

InteractionsRemoveRestrictionsForRepoRequestOptions

InteractionsRemoveRestrictionsForRepoRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

IssuesAddAssigneesEndpoint

IssuesAddAssigneesEndpoint: { assignees?: string[]; issue_number: number; owner: string; repo: string }

Type declaration

  • Optional assignees?: string[]

    Usernames of people to assign this issue to. NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise.

  • issue_number: number

    issue_number parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

IssuesAddAssigneesRequestOptions

IssuesAddAssigneesRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

IssuesAddLabelsEndpoint

IssuesAddLabelsEndpoint: { issue_number: number; labels: string[]; owner: string; repo: string }

Type declaration

  • issue_number: number

    issue_number parameter

  • labels: string[]

    The name of the label to add to the issue. Must contain at least one label. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

IssuesAddLabelsRequestOptions

IssuesAddLabelsRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

IssuesCheckAssigneeEndpoint

IssuesCheckAssigneeEndpoint: { assignee: string; owner: string; repo: string }

Type declaration

  • assignee: string

    assignee parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

IssuesCheckAssigneeRequestOptions

IssuesCheckAssigneeRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

IssuesCreateCommentEndpoint

IssuesCreateCommentEndpoint: { body: string; issue_number: number; owner: string; repo: string }

Type declaration

  • body: string

    The contents of the comment.

  • issue_number: number

    issue_number parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

IssuesCreateCommentRequestOptions

IssuesCreateCommentRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

IssuesCreateEndpoint

IssuesCreateEndpoint: { assignee?: string; assignees?: string[]; body?: string; labels?: string[]; milestone?: number; owner: string; repo: string; title: string }

Type declaration

  • Optional assignee?: string

    Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

  • Optional assignees?: string[]

    Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

  • Optional body?: string

    The contents of the issue.

  • Optional labels?: string[]

    Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

  • Optional milestone?: number

    The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • title: string

    The title of the issue.

IssuesCreateLabelEndpoint

IssuesCreateLabelEndpoint: { color: string; description?: string; name: string; owner: string; repo: string }

Type declaration

  • color: string

    The hexadecimal color code for the label, without the leading #.

  • Optional description?: string

    A short description of the label.

  • name: string

    The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji :strawberry:. For a full list of available emoji and codes, see emoji-cheat-sheet.com.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

IssuesCreateLabelRequestOptions

IssuesCreateLabelRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

IssuesCreateMilestoneEndpoint

IssuesCreateMilestoneEndpoint: { description?: string; due_on?: string; owner: string; repo: string; state?: "open" | "closed"; title: string }

Type declaration

  • Optional description?: string

    A description of the milestone.

  • Optional due_on?: string

    The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • Optional state?: "open" | "closed"

    The state of the milestone. Either open or closed.

  • title: string

    The title of the milestone.

IssuesCreateMilestoneRequestOptions

IssuesCreateMilestoneRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

IssuesCreateRequestOptions

IssuesCreateRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

IssuesDeleteCommentEndpoint

IssuesDeleteCommentEndpoint: { comment_id: number; owner: string; repo: string }

Type declaration

  • comment_id: number

    comment_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

IssuesDeleteCommentRequestOptions

IssuesDeleteCommentRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

IssuesDeleteLabelEndpoint

IssuesDeleteLabelEndpoint: { name: string; owner: string; repo: string }

Type declaration

  • name: string

    name parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

IssuesDeleteLabelRequestOptions

IssuesDeleteLabelRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

IssuesDeleteMilestoneEndpoint

IssuesDeleteMilestoneEndpoint: { milestone_number: number; owner: string; repo: string }

Type declaration

  • milestone_number: number

    milestone_number parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

IssuesDeleteMilestoneRequestOptions

IssuesDeleteMilestoneRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

IssuesGetCommentEndpoint

IssuesGetCommentEndpoint: { comment_id: number; owner: string; repo: string }

Type declaration

  • comment_id: number

    comment_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

IssuesGetCommentRequestOptions

IssuesGetCommentRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

IssuesGetEndpoint

IssuesGetEndpoint: { issue_number: number; owner: string; repo: string }

Type declaration

  • issue_number: number

    issue_number parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

IssuesGetEventEndpoint

IssuesGetEventEndpoint: { event_id: number; owner: string; repo: string }

Type declaration

  • event_id: number

    event_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

IssuesGetEventRequestOptions

IssuesGetEventRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

IssuesGetLabelEndpoint

IssuesGetLabelEndpoint: { name: string; owner: string; repo: string }

Type declaration

  • name: string

    name parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

IssuesGetLabelRequestOptions

IssuesGetLabelRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

IssuesGetMilestoneEndpoint

IssuesGetMilestoneEndpoint: { milestone_number: number; owner: string; repo: string }

Type declaration

  • milestone_number: number

    milestone_number parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

IssuesGetMilestoneRequestOptions

IssuesGetMilestoneRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

IssuesGetRequestOptions

IssuesGetRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

IssuesListAssigneesEndpoint

IssuesListAssigneesEndpoint: { owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

IssuesListAssigneesRequestOptions

IssuesListAssigneesRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

IssuesListCommentsEndpoint

IssuesListCommentsEndpoint: { issue_number: number; owner: string; page?: number; per_page?: number; repo: string; since?: string }

Type declaration

  • issue_number: number

    issue_number parameter

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

  • Optional since?: string

    Only comments updated at or after this time are returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

IssuesListCommentsForRepoEndpoint

IssuesListCommentsForRepoEndpoint: { direction?: "asc" | "desc"; owner: string; page?: number; per_page?: number; repo: string; since?: string; sort?: "created" | "updated" }

Type declaration

  • Optional direction?: "asc" | "desc"

    Either asc or desc. Ignored without the sort parameter.

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

  • Optional since?: string

    Only comments updated at or after this time are returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

  • Optional sort?: "created" | "updated"

    Either created or updated.

IssuesListCommentsForRepoRequestOptions

IssuesListCommentsForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

IssuesListCommentsRequestOptions

IssuesListCommentsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

IssuesListEndpoint

IssuesListEndpoint: { direction?: "asc" | "desc"; filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"; labels?: string; page?: number; per_page?: number; since?: string; sort?: "created" | "updated" | "comments"; state?: "open" | "closed" | "all" }

Type declaration

  • Optional direction?: "asc" | "desc"

    The direction of the sort. Can be either asc or desc.

  • Optional filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"

    Indicates which sorts of issues to return. Can be one of: * assigned: Issues assigned to you * created: Issues created by you * mentioned: Issues mentioning you * subscribed: Issues you're subscribed to updates for * all: All issues the authenticated user can see, regardless of participation or creation

  • Optional labels?: string

    A list of comma separated label names. Example: bug,ui,@high

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional since?: string

    Only issues updated at or after this time are returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

  • Optional sort?: "created" | "updated" | "comments"

    What to sort results by. Can be either created, updated, comments.

  • Optional state?: "open" | "closed" | "all"

    Indicates the state of the issues to return. Can be either open, closed, or all.

IssuesListEventsEndpoint

IssuesListEventsEndpoint: { issue_number: number; owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • issue_number: number

    issue_number parameter

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

IssuesListEventsForRepoEndpoint

IssuesListEventsForRepoEndpoint: { owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

IssuesListEventsForRepoRequestOptions

IssuesListEventsForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

IssuesListEventsForTimelineEndpoint

IssuesListEventsForTimelineEndpoint: { issue_number: number; owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • issue_number: number

    issue_number parameter

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

IssuesListEventsForTimelineRequestOptions

IssuesListEventsForTimelineRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

IssuesListEventsRequestOptions

IssuesListEventsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

IssuesListForAuthenticatedUserEndpoint

IssuesListForAuthenticatedUserEndpoint: { direction?: "asc" | "desc"; filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"; labels?: string; page?: number; per_page?: number; since?: string; sort?: "created" | "updated" | "comments"; state?: "open" | "closed" | "all" }

Type declaration

  • Optional direction?: "asc" | "desc"

    The direction of the sort. Can be either asc or desc.

  • Optional filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"

    Indicates which sorts of issues to return. Can be one of: * assigned: Issues assigned to you * created: Issues created by you * mentioned: Issues mentioning you * subscribed: Issues you're subscribed to updates for * all: All issues the authenticated user can see, regardless of participation or creation

  • Optional labels?: string

    A list of comma separated label names. Example: bug,ui,@high

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional since?: string

    Only issues updated at or after this time are returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

  • Optional sort?: "created" | "updated" | "comments"

    What to sort results by. Can be either created, updated, comments.

  • Optional state?: "open" | "closed" | "all"

    Indicates the state of the issues to return. Can be either open, closed, or all.

IssuesListForAuthenticatedUserRequestOptions

IssuesListForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

IssuesListForOrgEndpoint

IssuesListForOrgEndpoint: { direction?: "asc" | "desc"; filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"; labels?: string; org: string; page?: number; per_page?: number; since?: string; sort?: "created" | "updated" | "comments"; state?: "open" | "closed" | "all" }

Type declaration

  • Optional direction?: "asc" | "desc"

    The direction of the sort. Can be either asc or desc.

  • Optional filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"

    Indicates which sorts of issues to return. Can be one of: * assigned: Issues assigned to you * created: Issues created by you * mentioned: Issues mentioning you * subscribed: Issues you're subscribed to updates for * all: All issues the authenticated user can see, regardless of participation or creation

  • Optional labels?: string

    A list of comma separated label names. Example: bug,ui,@high

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional since?: string

    Only issues updated at or after this time are returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

  • Optional sort?: "created" | "updated" | "comments"

    What to sort results by. Can be either created, updated, comments.

  • Optional state?: "open" | "closed" | "all"

    Indicates the state of the issues to return. Can be either open, closed, or all.

IssuesListForOrgRequestOptions

IssuesListForOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

IssuesListForRepoEndpoint

IssuesListForRepoEndpoint: { assignee?: string; creator?: string; direction?: "asc" | "desc"; labels?: string; mentioned?: string; milestone?: string; owner: string; page?: number; per_page?: number; repo: string; since?: string; sort?: "created" | "updated" | "comments"; state?: "open" | "closed" | "all" }

Type declaration

  • Optional assignee?: string

    Can be the name of a user. Pass in none for issues with no assigned user, and * for issues assigned to any user.

  • Optional creator?: string

    The user that created the issue.

  • Optional direction?: "asc" | "desc"

    The direction of the sort. Can be either asc or desc.

  • Optional labels?: string

    A list of comma separated label names. Example: bug,ui,@high

  • Optional mentioned?: string

    A user that's mentioned in the issue.

  • Optional milestone?: string

    If an integer is passed, it should refer to a milestone by its number field. If the string * is passed, issues with any milestone are accepted. If the string none is passed, issues without milestones are returned.

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

  • Optional since?: string

    Only issues updated at or after this time are returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

  • Optional sort?: "created" | "updated" | "comments"

    What to sort results by. Can be either created, updated, comments.

  • Optional state?: "open" | "closed" | "all"

    Indicates the state of the issues to return. Can be either open, closed, or all.

IssuesListForRepoRequestOptions

IssuesListForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

IssuesListLabelsForMilestoneEndpoint

IssuesListLabelsForMilestoneEndpoint: { milestone_number: number; owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • milestone_number: number

    milestone_number parameter

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

IssuesListLabelsForMilestoneRequestOptions

IssuesListLabelsForMilestoneRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

IssuesListLabelsForRepoEndpoint

IssuesListLabelsForRepoEndpoint: { owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

IssuesListLabelsForRepoRequestOptions

IssuesListLabelsForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

IssuesListLabelsOnIssueEndpoint

IssuesListLabelsOnIssueEndpoint: { issue_number: number; owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • issue_number: number

    issue_number parameter

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

IssuesListLabelsOnIssueRequestOptions

IssuesListLabelsOnIssueRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

IssuesListMilestonesForRepoEndpoint

IssuesListMilestonesForRepoEndpoint: { direction?: "asc" | "desc"; owner: string; page?: number; per_page?: number; repo: string; sort?: "due_on" | "completeness"; state?: "open" | "closed" | "all" }

Type declaration

  • Optional direction?: "asc" | "desc"

    The direction of the sort. Either asc or desc.

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

  • Optional sort?: "due_on" | "completeness"

    What to sort results by. Either due_on or completeness.

  • Optional state?: "open" | "closed" | "all"

    The state of the milestone. Either open, closed, or all.

IssuesListMilestonesForRepoRequestOptions

IssuesListMilestonesForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

IssuesListRequestOptions

IssuesListRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

IssuesLockEndpoint

IssuesLockEndpoint: { issue_number: number; lock_reason?: "off-topic" | "too heated" | "resolved" | "spam"; owner: string; repo: string }

Type declaration

  • issue_number: number

    issue_number parameter

  • Optional lock_reason?: "off-topic" | "too heated" | "resolved" | "spam"

    The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: * off-topic * too heated * resolved * spam

  • owner: string

    owner parameter

  • repo: string

    repo parameter

IssuesLockRequestOptions

IssuesLockRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

IssuesRemoveAllLabelsEndpoint

IssuesRemoveAllLabelsEndpoint: { issue_number: number; owner: string; repo: string }

Type declaration

  • issue_number: number

    issue_number parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

IssuesRemoveAllLabelsRequestOptions

IssuesRemoveAllLabelsRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

IssuesRemoveAssigneesEndpoint

IssuesRemoveAssigneesEndpoint: { assignees?: string[]; issue_number: number; owner: string; repo: string }

Type declaration

  • Optional assignees?: string[]

    Usernames of assignees to remove from an issue. NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise.

  • issue_number: number

    issue_number parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

IssuesRemoveAssigneesRequestOptions

IssuesRemoveAssigneesRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

IssuesRemoveLabelEndpoint

IssuesRemoveLabelEndpoint: { issue_number: number; name: string; owner: string; repo: string }

Type declaration

  • issue_number: number

    issue_number parameter

  • name: string

    name parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

IssuesRemoveLabelRequestOptions

IssuesRemoveLabelRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

IssuesRemoveLabelsEndpoint

IssuesRemoveLabelsEndpoint: { issue_number: number; owner: string; repo: string }

Type declaration

  • issue_number: number

    issue_number parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

IssuesRemoveLabelsRequestOptions

IssuesRemoveLabelsRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

IssuesReplaceAllLabelsEndpoint

IssuesReplaceAllLabelsEndpoint: { issue_number: number; labels?: string[]; owner: string; repo: string }

Type declaration

  • issue_number: number

    issue_number parameter

  • Optional labels?: string[]

    The names of the labels to add to the issue. You can pass an empty array to remove all labels. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

IssuesReplaceAllLabelsRequestOptions

IssuesReplaceAllLabelsRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

IssuesReplaceLabelsEndpoint

IssuesReplaceLabelsEndpoint: { issue_number: number; labels?: string[]; owner: string; repo: string }

Type declaration

  • issue_number: number

    issue_number parameter

  • Optional labels?: string[]

    The names of the labels to add to the issue. You can pass an empty array to remove all labels. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

IssuesReplaceLabelsRequestOptions

IssuesReplaceLabelsRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

IssuesUnlockEndpoint

IssuesUnlockEndpoint: { issue_number: number; owner: string; repo: string }

Type declaration

  • issue_number: number

    issue_number parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

IssuesUnlockRequestOptions

IssuesUnlockRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

IssuesUpdateCommentEndpoint

IssuesUpdateCommentEndpoint: { body: string; comment_id: number; owner: string; repo: string }

Type declaration

  • body: string

    The contents of the comment.

  • comment_id: number

    comment_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

IssuesUpdateCommentRequestOptions

IssuesUpdateCommentRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

IssuesUpdateEndpoint

IssuesUpdateEndpoint: { assignee?: string; assignees?: string[]; body?: string; issue_number: number; labels?: string[]; milestone?: number | null; owner: string; repo: string; state?: "open" | "closed"; title?: string }

Type declaration

  • Optional assignee?: string

    Login for the user that this issue should be assigned to. This field is deprecated.

  • Optional assignees?: string[]

    Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

  • Optional body?: string

    The contents of the issue.

  • issue_number: number

    issue_number parameter

  • Optional labels?: string[]

    Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

  • Optional milestone?: number | null

    The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • Optional state?: "open" | "closed"

    State of the issue. Either open or closed.

  • Optional title?: string

    The title of the issue.

IssuesUpdateLabelEndpoint

IssuesUpdateLabelEndpoint: { color?: string; description?: string; name: string; new_name?: string; owner: string; repo: string }

Type declaration

  • Optional color?: string

    The hexadecimal color code for the label, without the leading #.

  • Optional description?: string

    A short description of the label.

  • name: string

    name parameter

  • Optional new_name?: string

    The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji :strawberry:. For a full list of available emoji and codes, see emoji-cheat-sheet.com.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

IssuesUpdateLabelRequestOptions

IssuesUpdateLabelRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

IssuesUpdateMilestoneEndpoint

IssuesUpdateMilestoneEndpoint: { description?: string; due_on?: string; milestone_number: number; owner: string; repo: string; state?: "open" | "closed"; title?: string }

Type declaration

  • Optional description?: string

    A description of the milestone.

  • Optional due_on?: string

    The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

  • milestone_number: number

    milestone_number parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • Optional state?: "open" | "closed"

    The state of the milestone. Either open or closed.

  • Optional title?: string

    The title of the milestone.

IssuesUpdateMilestoneRequestOptions

IssuesUpdateMilestoneRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

IssuesUpdateRequestOptions

IssuesUpdateRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

LicensesGetEndpoint

LicensesGetEndpoint: { license: string }

Type declaration

  • license: string

    license parameter

LicensesGetForRepoEndpoint

LicensesGetForRepoEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

LicensesGetForRepoRequestOptions

LicensesGetForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

LicensesGetRequestOptions

LicensesGetRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

LicensesListCommonlyUsedEndpoint

LicensesListCommonlyUsedEndpoint: {}

Type declaration

LicensesListCommonlyUsedRequestOptions

LicensesListCommonlyUsedRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

LicensesListEndpoint

LicensesListEndpoint: {}

Type declaration

LicensesListRequestOptions

LicensesListRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

MarkdownRenderEndpoint

MarkdownRenderEndpoint: { context?: string; mode?: "markdown" | "gfm"; text: string }

Type declaration

  • Optional context?: string

    The repository context to use when creating references in gfm mode. Omit this parameter when using markdown mode.

  • Optional mode?: "markdown" | "gfm"

    The rendering mode. Can be either: * markdown to render a document in plain Markdown, just like README.md files are rendered. * gfm to render a document in GitHub Flavored Markdown, which creates links for user mentions as well as references to SHA-1 hashes, issues, and pull requests.

  • text: string

    The Markdown text to render in HTML. Markdown content must be 400 KB or less.

MarkdownRenderRawEndpoint

MarkdownRenderRawEndpoint: { data: string }

Type declaration

  • data: string

    data parameter

MarkdownRenderRawRequestOptions

MarkdownRenderRawRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

MarkdownRenderRequestOptions

MarkdownRenderRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

MetaGetEndpoint

MetaGetEndpoint: {}

Type declaration

MetaGetRequestOptions

MetaGetRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

MigrationsCancelImportEndpoint

MigrationsCancelImportEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

MigrationsCancelImportRequestOptions

MigrationsCancelImportRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

MigrationsDeleteArchiveForAuthenticatedUserEndpoint

MigrationsDeleteArchiveForAuthenticatedUserEndpoint: { migration_id: number }

Type declaration

  • migration_id: number

    migration_id parameter

MigrationsDeleteArchiveForAuthenticatedUserRequestOptions

MigrationsDeleteArchiveForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

MigrationsDeleteArchiveForOrgEndpoint

MigrationsDeleteArchiveForOrgEndpoint: { migration_id: number; org: string }

Type declaration

  • migration_id: number

    migration_id parameter

  • org: string

    org parameter

MigrationsDeleteArchiveForOrgRequestOptions

MigrationsDeleteArchiveForOrgRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

MigrationsDownloadArchiveForOrgEndpoint

MigrationsDownloadArchiveForOrgEndpoint: { migration_id: number; org: string }

Type declaration

  • migration_id: number

    migration_id parameter

  • org: string

    org parameter

MigrationsDownloadArchiveForOrgRequestOptions

MigrationsDownloadArchiveForOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

MigrationsGetArchiveForAuthenticatedUserEndpoint

MigrationsGetArchiveForAuthenticatedUserEndpoint: { migration_id: number }

Type declaration

  • migration_id: number

    migration_id parameter

MigrationsGetArchiveForAuthenticatedUserRequestOptions

MigrationsGetArchiveForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

MigrationsGetArchiveForOrgEndpoint

MigrationsGetArchiveForOrgEndpoint: { migration_id: number; org: string }

Type declaration

  • migration_id: number

    migration_id parameter

  • org: string

    org parameter

MigrationsGetArchiveForOrgRequestOptions

MigrationsGetArchiveForOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

MigrationsGetCommitAuthorsEndpoint

MigrationsGetCommitAuthorsEndpoint: { owner: string; repo: string; since?: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • Optional since?: string

    Only authors found after this id are returned. Provide the highest author ID you've seen so far. New authors may be added to the list at any point while the importer is performing the raw step.

MigrationsGetCommitAuthorsRequestOptions

MigrationsGetCommitAuthorsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

MigrationsGetImportProgressEndpoint

MigrationsGetImportProgressEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

MigrationsGetImportProgressRequestOptions

MigrationsGetImportProgressRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

MigrationsGetLargeFilesEndpoint

MigrationsGetLargeFilesEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

MigrationsGetLargeFilesRequestOptions

MigrationsGetLargeFilesRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

MigrationsGetStatusForAuthenticatedUserEndpoint

MigrationsGetStatusForAuthenticatedUserEndpoint: { migration_id: number }

Type declaration

  • migration_id: number

    migration_id parameter

MigrationsGetStatusForAuthenticatedUserRequestOptions

MigrationsGetStatusForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

MigrationsGetStatusForOrgEndpoint

MigrationsGetStatusForOrgEndpoint: { migration_id: number; org: string }

Type declaration

  • migration_id: number

    migration_id parameter

  • org: string

    org parameter

MigrationsGetStatusForOrgRequestOptions

MigrationsGetStatusForOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

MigrationsListForAuthenticatedUserEndpoint

MigrationsListForAuthenticatedUserEndpoint: { page?: number; per_page?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

MigrationsListForAuthenticatedUserRequestOptions

MigrationsListForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

MigrationsListForOrgEndpoint

MigrationsListForOrgEndpoint: { org: string; page?: number; per_page?: number }

Type declaration

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

MigrationsListForOrgRequestOptions

MigrationsListForOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

MigrationsListReposForOrgEndpoint

MigrationsListReposForOrgEndpoint: { migration_id: number; org: string; page?: number; per_page?: number }

Type declaration

  • migration_id: number

    migration_id parameter

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

MigrationsListReposForOrgRequestOptions

MigrationsListReposForOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

MigrationsListReposForUserEndpoint

MigrationsListReposForUserEndpoint: { migration_id: number; page?: number; per_page?: number }

Type declaration

  • migration_id: number

    migration_id parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

MigrationsListReposForUserRequestOptions

MigrationsListReposForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

MigrationsMapCommitAuthorEndpoint

MigrationsMapCommitAuthorEndpoint: { author_id: number; email?: string; name?: string; owner: string; repo: string }

Type declaration

  • author_id: number

    author_id parameter

  • Optional email?: string

    The new Git author email.

  • Optional name?: string

    The new Git author name.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

MigrationsMapCommitAuthorRequestOptions

MigrationsMapCommitAuthorRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

MigrationsSetLfsPreferenceEndpoint

MigrationsSetLfsPreferenceEndpoint: { owner: string; repo: string; use_lfs: "opt_in" | "opt_out" }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • use_lfs: "opt_in" | "opt_out"

    Can be one of opt_in (large files will be stored using Git LFS) or opt_out (large files will be removed during the import).

MigrationsSetLfsPreferenceRequestOptions

MigrationsSetLfsPreferenceRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

MigrationsStartForAuthenticatedUserEndpoint

MigrationsStartForAuthenticatedUserEndpoint: { exclude_attachments?: boolean; lock_repositories?: boolean; repositories: string[] }

Type declaration

  • Optional exclude_attachments?: boolean

    Does not include attachments uploaded to GitHub.com in the migration data when set to true. Excluding attachments will reduce the migration archive file size.

  • Optional lock_repositories?: boolean

    Locks the repositories to prevent changes during the migration when set to true.

  • repositories: string[]

    An array of repositories to include in the migration.

MigrationsStartForAuthenticatedUserRequestOptions

MigrationsStartForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

MigrationsStartForOrgEndpoint

MigrationsStartForOrgEndpoint: { exclude_attachments?: boolean; lock_repositories?: boolean; org: string; repositories: string[] }

Type declaration

  • Optional exclude_attachments?: boolean

    Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).

  • Optional lock_repositories?: boolean

    Indicates whether repositories should be locked (to prevent manipulation) while migrating data.

  • org: string

    org parameter

  • repositories: string[]

    A list of arrays indicating which repositories should be migrated.

MigrationsStartForOrgRequestOptions

MigrationsStartForOrgRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

MigrationsStartImportEndpoint

MigrationsStartImportEndpoint: { owner: string; repo: string; tfvc_project?: string; vcs?: "subversion" | "git" | "mercurial" | "tfvc"; vcs_password?: string; vcs_url: string; vcs_username?: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • Optional tfvc_project?: string

    For a tfvc import, the name of the project that is being imported.

  • Optional vcs?: "subversion" | "git" | "mercurial" | "tfvc"

    The originating VCS type. Can be one of subversion, git, mercurial, or tfvc. Please be aware that without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response.

  • Optional vcs_password?: string

    If authentication is required, the password to provide to vcs_url.

  • vcs_url: string

    The URL of the originating repository.

  • Optional vcs_username?: string

    If authentication is required, the username to provide to vcs_url.

MigrationsStartImportRequestOptions

MigrationsStartImportRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

MigrationsUnlockRepoForAuthenticatedUserEndpoint

MigrationsUnlockRepoForAuthenticatedUserEndpoint: { migration_id: number; repo_name: string }

Type declaration

  • migration_id: number

    migration_id parameter

  • repo_name: string

    repo_name parameter

MigrationsUnlockRepoForAuthenticatedUserRequestOptions

MigrationsUnlockRepoForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

MigrationsUnlockRepoForOrgEndpoint

MigrationsUnlockRepoForOrgEndpoint: { migration_id: number; org: string; repo_name: string }

Type declaration

  • migration_id: number

    migration_id parameter

  • org: string

    org parameter

  • repo_name: string

    repo_name parameter

MigrationsUnlockRepoForOrgRequestOptions

MigrationsUnlockRepoForOrgRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

MigrationsUpdateImportEndpoint

MigrationsUpdateImportEndpoint: { owner: string; repo: string; vcs_password?: string; vcs_username?: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • Optional vcs_password?: string

    The password to provide to the originating repository.

  • Optional vcs_username?: string

    The username to provide to the originating repository.

MigrationsUpdateImportRequestOptions

MigrationsUpdateImportRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

OauthAuthorizationsCheckAuthorizationEndpoint

OauthAuthorizationsCheckAuthorizationEndpoint: { access_token: string; client_id: string }

Type declaration

  • access_token: string

    access_token parameter

  • client_id: string

    client_id parameter

OauthAuthorizationsCheckAuthorizationRequestOptions

OauthAuthorizationsCheckAuthorizationRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

OauthAuthorizationsCreateAuthorizationEndpoint

OauthAuthorizationsCreateAuthorizationEndpoint: { client_id?: string; client_secret?: string; fingerprint?: string; note: string; note_url?: string; scopes?: string[] }

Type declaration

  • Optional client_id?: string

    The 20 character OAuth app client key for which to create the token.

  • Optional client_secret?: string

    The 40 character OAuth app client secret for which to create the token.

  • Optional fingerprint?: string

    A unique string to distinguish an authorization from others created for the same client ID and user.

  • note: string

    A note to remind you what the OAuth token is for. Tokens not associated with a specific OAuth application (i.e. personal access tokens) must have a unique note.

  • Optional note_url?: string

    A URL to remind you what app the OAuth token is for.

  • Optional scopes?: string[]

    A list of scopes that this authorization is in.

OauthAuthorizationsCreateAuthorizationRequestOptions

OauthAuthorizationsCreateAuthorizationRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

OauthAuthorizationsDeleteAuthorizationEndpoint

OauthAuthorizationsDeleteAuthorizationEndpoint: { authorization_id: number }

Type declaration

  • authorization_id: number

    authorization_id parameter

OauthAuthorizationsDeleteAuthorizationRequestOptions

OauthAuthorizationsDeleteAuthorizationRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

OauthAuthorizationsDeleteGrantEndpoint

OauthAuthorizationsDeleteGrantEndpoint: { grant_id: number }

Type declaration

  • grant_id: number

    grant_id parameter

OauthAuthorizationsDeleteGrantRequestOptions

OauthAuthorizationsDeleteGrantRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

OauthAuthorizationsGetAuthorizationEndpoint

OauthAuthorizationsGetAuthorizationEndpoint: { authorization_id: number }

Type declaration

  • authorization_id: number

    authorization_id parameter

OauthAuthorizationsGetAuthorizationRequestOptions

OauthAuthorizationsGetAuthorizationRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

OauthAuthorizationsGetGrantEndpoint

OauthAuthorizationsGetGrantEndpoint: { grant_id: number }

Type declaration

  • grant_id: number

    grant_id parameter

OauthAuthorizationsGetGrantRequestOptions

OauthAuthorizationsGetGrantRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintEndpoint

OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintEndpoint: { client_id: string; client_secret: string; fingerprint: string; note?: string; note_url?: string; scopes?: string[] }

Type declaration

  • client_id: string

    client_id parameter

  • client_secret: string

    The 40 character OAuth app client secret associated with the client ID specified in the URL.

  • fingerprint: string

    fingerprint parameter

  • Optional note?: string

    A note to remind you what the OAuth token is for.

  • Optional note_url?: string

    A URL to remind you what app the OAuth token is for.

  • Optional scopes?: string[]

    A list of scopes that this authorization is in.

OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintRequestOptions

OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

OauthAuthorizationsGetOrCreateAuthorizationForAppEndpoint

OauthAuthorizationsGetOrCreateAuthorizationForAppEndpoint: { client_id: string; client_secret: string; fingerprint?: string; note?: string; note_url?: string; scopes?: string[] }

Type declaration

  • client_id: string

    client_id parameter

  • client_secret: string

    The 40 character OAuth app client secret associated with the client ID specified in the URL.

  • Optional fingerprint?: string

    A unique string to distinguish an authorization from others created for the same client and user. If provided, this API is functionally equivalent to Get-or-create an authorization for a specific app and fingerprint.

  • Optional note?: string

    A note to remind you what the OAuth token is for.

  • Optional note_url?: string

    A URL to remind you what app the OAuth token is for.

  • Optional scopes?: string[]

    A list of scopes that this authorization is in.

OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintEndpoint

OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintEndpoint: { client_id: string; client_secret: string; fingerprint: string; note?: string; note_url?: string; scopes?: string[] }

Type declaration

  • client_id: string

    client_id parameter

  • client_secret: string

    The 40 character OAuth app client secret associated with the client ID specified in the URL.

  • fingerprint: string

    fingerprint parameter

  • Optional note?: string

    A note to remind you what the OAuth token is for.

  • Optional note_url?: string

    A URL to remind you what app the OAuth token is for.

  • Optional scopes?: string[]

    A list of scopes that this authorization is in.

OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintRequestOptions

OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

OauthAuthorizationsGetOrCreateAuthorizationForAppRequestOptions

OauthAuthorizationsGetOrCreateAuthorizationForAppRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

OauthAuthorizationsListAuthorizationsEndpoint

OauthAuthorizationsListAuthorizationsEndpoint: { page?: number; per_page?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

OauthAuthorizationsListAuthorizationsRequestOptions

OauthAuthorizationsListAuthorizationsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

OauthAuthorizationsListGrantsEndpoint

OauthAuthorizationsListGrantsEndpoint: { page?: number; per_page?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

OauthAuthorizationsListGrantsRequestOptions

OauthAuthorizationsListGrantsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

OauthAuthorizationsResetAuthorizationEndpoint

OauthAuthorizationsResetAuthorizationEndpoint: { access_token: string; client_id: string }

Type declaration

  • access_token: string

    access_token parameter

  • client_id: string

    client_id parameter

OauthAuthorizationsResetAuthorizationRequestOptions

OauthAuthorizationsResetAuthorizationRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

OauthAuthorizationsRevokeAuthorizationForApplicationEndpoint

OauthAuthorizationsRevokeAuthorizationForApplicationEndpoint: { access_token: string; client_id: string }

Type declaration

  • access_token: string

    access_token parameter

  • client_id: string

    client_id parameter

OauthAuthorizationsRevokeAuthorizationForApplicationRequestOptions

OauthAuthorizationsRevokeAuthorizationForApplicationRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

OauthAuthorizationsRevokeGrantForApplicationEndpoint

OauthAuthorizationsRevokeGrantForApplicationEndpoint: { access_token: string; client_id: string }

Type declaration

  • access_token: string

    access_token parameter

  • client_id: string

    client_id parameter

OauthAuthorizationsRevokeGrantForApplicationRequestOptions

OauthAuthorizationsRevokeGrantForApplicationRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

OauthAuthorizationsUpdateAuthorizationEndpoint

OauthAuthorizationsUpdateAuthorizationEndpoint: { add_scopes?: string[]; authorization_id: number; fingerprint?: string; note?: string; note_url?: string; remove_scopes?: string[]; scopes?: string[] }

Type declaration

  • Optional add_scopes?: string[]

    A list of scopes to add to this authorization.

  • authorization_id: number

    authorization_id parameter

  • Optional fingerprint?: string

    A unique string to distinguish an authorization from others created for the same client ID and user.

  • Optional note?: string

    A note to remind you what the OAuth token is for. Tokens not associated with a specific OAuth application (i.e. personal access tokens) must have a unique note.

  • Optional note_url?: string

    A URL to remind you what app the OAuth token is for.

  • Optional remove_scopes?: string[]

    A list of scopes to remove from this authorization.

  • Optional scopes?: string[]

    Replaces the authorization scopes with these.

OauthAuthorizationsUpdateAuthorizationRequestOptions

OauthAuthorizationsUpdateAuthorizationRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

OrgsAddOrUpdateMembershipEndpoint

OrgsAddOrUpdateMembershipEndpoint: { org: string; role?: "admin" | "member"; username: string }

Type declaration

  • org: string

    org parameter

  • Optional role?: "admin" | "member"

    The role to give the user in the organization. Can be one of: * admin - The user will become an owner of the organization. * member - The user will become a non-owner member of the organization.

  • username: string

    username parameter

OrgsAddOrUpdateMembershipRequestOptions

OrgsAddOrUpdateMembershipRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

OrgsBlockUserEndpoint

OrgsBlockUserEndpoint: { org: string; username: string }

Type declaration

  • org: string

    org parameter

  • username: string

    username parameter

OrgsBlockUserRequestOptions

OrgsBlockUserRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

OrgsCheckBlockedUserEndpoint

OrgsCheckBlockedUserEndpoint: { org: string; username: string }

Type declaration

  • org: string

    org parameter

  • username: string

    username parameter

OrgsCheckBlockedUserRequestOptions

OrgsCheckBlockedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

OrgsCheckMembershipEndpoint

OrgsCheckMembershipEndpoint: { org: string; username: string }

Type declaration

  • org: string

    org parameter

  • username: string

    username parameter

OrgsCheckMembershipRequestOptions

OrgsCheckMembershipRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

OrgsCheckPublicMembershipEndpoint

OrgsCheckPublicMembershipEndpoint: { org: string; username: string }

Type declaration

  • org: string

    org parameter

  • username: string

    username parameter

OrgsCheckPublicMembershipRequestOptions

OrgsCheckPublicMembershipRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

OrgsConcealMembershipEndpoint

OrgsConcealMembershipEndpoint: { org: string; username: string }

Type declaration

  • org: string

    org parameter

  • username: string

    username parameter

OrgsConcealMembershipRequestOptions

OrgsConcealMembershipRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

OrgsConvertMemberToOutsideCollaboratorEndpoint

OrgsConvertMemberToOutsideCollaboratorEndpoint: { org: string; username: string }

Type declaration

  • org: string

    org parameter

  • username: string

    username parameter

OrgsConvertMemberToOutsideCollaboratorRequestOptions

OrgsConvertMemberToOutsideCollaboratorRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

OrgsCreateHookEndpoint

OrgsCreateHookEndpoint: { active?: boolean; config: OrgsCreateHookParamsConfig; events?: string[]; name: string; org: string }

Type declaration

  • Optional active?: boolean

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

  • config: OrgsCreateHookParamsConfig

    Key/value pairs to provide settings for this webhook. These are defined below.

  • Optional events?: string[]

    Determines what events the hook is triggered for.

  • name: string

    Must be passed as "web".

  • org: string

    org parameter

OrgsCreateHookParamsConfig

OrgsCreateHookParamsConfig: { content_type?: string; insecure_ssl?: string; secret?: string; url: string }

Type declaration

  • Optional content_type?: string
  • Optional insecure_ssl?: string
  • Optional secret?: string
  • url: string

OrgsCreateHookRequestOptions

OrgsCreateHookRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

OrgsCreateInvitationEndpoint

OrgsCreateInvitationEndpoint: { email?: string; invitee_id?: number; org: string; role?: "admin" | "direct_member" | "billing_manager"; team_ids?: number[] }

Type declaration

  • Optional email?: string

    Required unless you provide invitee_id. Email address of the person you are inviting, which can be an existing GitHub user.

  • Optional invitee_id?: number

    Required unless you provide email. GitHub user ID for the person you are inviting.

  • org: string

    org parameter

  • Optional role?: "admin" | "direct_member" | "billing_manager"

    Specify role for new member. Can be one of: * admin - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. * direct_member - Non-owner organization members with ability to see other members and join teams by invitation. * billing_manager - Non-owner organization members with ability to manage the billing settings of your organization.

  • Optional team_ids?: number[]

    Specify IDs for the teams you want to invite new members to.

OrgsCreateInvitationRequestOptions

OrgsCreateInvitationRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

OrgsDeleteHookEndpoint

OrgsDeleteHookEndpoint: { hook_id: number; org: string }

Type declaration

  • hook_id: number

    hook_id parameter

  • org: string

    org parameter

OrgsDeleteHookRequestOptions

OrgsDeleteHookRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

OrgsGetEndpoint

OrgsGetEndpoint: { org: string }

Type declaration

  • org: string

    org parameter

OrgsGetHookEndpoint

OrgsGetHookEndpoint: { hook_id: number; org: string }

Type declaration

  • hook_id: number

    hook_id parameter

  • org: string

    org parameter

OrgsGetHookRequestOptions

OrgsGetHookRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

OrgsGetMembershipEndpoint

OrgsGetMembershipEndpoint: { org: string; username: string }

Type declaration

  • org: string

    org parameter

  • username: string

    username parameter

OrgsGetMembershipForAuthenticatedUserEndpoint

OrgsGetMembershipForAuthenticatedUserEndpoint: { org: string }

Type declaration

  • org: string

    org parameter

OrgsGetMembershipForAuthenticatedUserRequestOptions

OrgsGetMembershipForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

OrgsGetMembershipRequestOptions

OrgsGetMembershipRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

OrgsGetRequestOptions

OrgsGetRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

OrgsListBlockedUsersEndpoint

OrgsListBlockedUsersEndpoint: { org: string }

Type declaration

  • org: string

    org parameter

OrgsListBlockedUsersRequestOptions

OrgsListBlockedUsersRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

OrgsListCredentialAuthorizationsEndpoint

OrgsListCredentialAuthorizationsEndpoint: { org: string }

Type declaration

  • org: string

    org parameter

OrgsListCredentialAuthorizationsRequestOptions

OrgsListCredentialAuthorizationsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

OrgsListEndpoint

OrgsListEndpoint: { page?: number; per_page?: number; since?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional since?: number

    The integer ID of the last organization that you've seen.

OrgsListForAuthenticatedUserEndpoint

OrgsListForAuthenticatedUserEndpoint: { page?: number; per_page?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

OrgsListForAuthenticatedUserRequestOptions

OrgsListForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

OrgsListForUserEndpoint

OrgsListForUserEndpoint: { page?: number; per_page?: number; username: string }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • username: string

    username parameter

OrgsListForUserRequestOptions

OrgsListForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

OrgsListHooksEndpoint

OrgsListHooksEndpoint: { org: string; page?: number; per_page?: number }

Type declaration

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

OrgsListHooksRequestOptions

OrgsListHooksRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

OrgsListInstallationsEndpoint

OrgsListInstallationsEndpoint: { org: string; page?: number; per_page?: number }

Type declaration

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

OrgsListInstallationsRequestOptions

OrgsListInstallationsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

OrgsListInvitationTeamsEndpoint

OrgsListInvitationTeamsEndpoint: { invitation_id: number; org: string; page?: number; per_page?: number }

Type declaration

  • invitation_id: number

    invitation_id parameter

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

OrgsListInvitationTeamsRequestOptions

OrgsListInvitationTeamsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

OrgsListMembersEndpoint

OrgsListMembersEndpoint: { filter?: "2fa_disabled" | "all"; org: string; page?: number; per_page?: number; role?: "all" | "admin" | "member" }

Type declaration

  • Optional filter?: "2fa_disabled" | "all"

    Filter members returned in the list. Can be one of: * 2fa_disabled - Members without two-factor authentication enabled. Available for organization owners. * all - All members the authenticated user can see.

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional role?: "all" | "admin" | "member"

    Filter members returned by their role. Can be one of: * all - All members of the organization, regardless of role. * admin - Organization owners. * member - Non-owner organization members.

OrgsListMembersRequestOptions

OrgsListMembersRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

OrgsListMembershipsEndpoint

OrgsListMembershipsEndpoint: { page?: number; per_page?: number; state?: "active" | "pending" }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional state?: "active" | "pending"

    Indicates the state of the memberships to return. Can be either active or pending. If not specified, the API returns both active and pending memberships.

OrgsListMembershipsRequestOptions

OrgsListMembershipsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

OrgsListOutsideCollaboratorsEndpoint

OrgsListOutsideCollaboratorsEndpoint: { filter?: "2fa_disabled" | "all"; org: string; page?: number; per_page?: number }

Type declaration

  • Optional filter?: "2fa_disabled" | "all"

    Filter the list of outside collaborators. Can be one of: * 2fa_disabled: Outside collaborators without two-factor authentication enabled. * all: All outside collaborators.

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

OrgsListOutsideCollaboratorsRequestOptions

OrgsListOutsideCollaboratorsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

OrgsListPendingInvitationsEndpoint

OrgsListPendingInvitationsEndpoint: { org: string; page?: number; per_page?: number }

Type declaration

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

OrgsListPendingInvitationsRequestOptions

OrgsListPendingInvitationsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

OrgsListPublicMembersEndpoint

OrgsListPublicMembersEndpoint: { org: string; page?: number; per_page?: number }

Type declaration

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

OrgsListPublicMembersRequestOptions

OrgsListPublicMembersRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

OrgsListRequestOptions

OrgsListRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

OrgsPingHookEndpoint

OrgsPingHookEndpoint: { hook_id: number; org: string }

Type declaration

  • hook_id: number

    hook_id parameter

  • org: string

    org parameter

OrgsPingHookRequestOptions

OrgsPingHookRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

OrgsPublicizeMembershipEndpoint

OrgsPublicizeMembershipEndpoint: { org: string; username: string }

Type declaration

  • org: string

    org parameter

  • username: string

    username parameter

OrgsPublicizeMembershipRequestOptions

OrgsPublicizeMembershipRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

OrgsRemoveCredentialAuthorizationEndpoint

OrgsRemoveCredentialAuthorizationEndpoint: { credential_id: number; org: string }

Type declaration

  • credential_id: number

    credential_id parameter

  • org: string

    org parameter

OrgsRemoveCredentialAuthorizationRequestOptions

OrgsRemoveCredentialAuthorizationRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

OrgsRemoveMemberEndpoint

OrgsRemoveMemberEndpoint: { org: string; username: string }

Type declaration

  • org: string

    org parameter

  • username: string

    username parameter

OrgsRemoveMemberRequestOptions

OrgsRemoveMemberRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

OrgsRemoveMembershipEndpoint

OrgsRemoveMembershipEndpoint: { org: string; username: string }

Type declaration

  • org: string

    org parameter

  • username: string

    username parameter

OrgsRemoveMembershipRequestOptions

OrgsRemoveMembershipRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

OrgsRemoveOutsideCollaboratorEndpoint

OrgsRemoveOutsideCollaboratorEndpoint: { org: string; username: string }

Type declaration

  • org: string

    org parameter

  • username: string

    username parameter

OrgsRemoveOutsideCollaboratorRequestOptions

OrgsRemoveOutsideCollaboratorRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

OrgsUnblockUserEndpoint

OrgsUnblockUserEndpoint: { org: string; username: string }

Type declaration

  • org: string

    org parameter

  • username: string

    username parameter

OrgsUnblockUserRequestOptions

OrgsUnblockUserRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

OrgsUpdateEndpoint

OrgsUpdateEndpoint: { billing_email?: string; company?: string; default_repository_permission?: "read" | "write" | "admin" | "none"; description?: string; email?: string; has_organization_projects?: boolean; has_repository_projects?: boolean; location?: string; members_allowed_repository_creation_type?: "all" | "private" | "none"; members_can_create_internal_repositories?: boolean; members_can_create_private_repositories?: boolean; members_can_create_public_repositories?: boolean; members_can_create_repositories?: boolean; name?: string; org: string }

Type declaration

  • Optional billing_email?: string

    Billing email address. This address is not publicized.

  • Optional company?: string

    The company name.

  • Optional default_repository_permission?: "read" | "write" | "admin" | "none"

    Default permission level members have for organization repositories: * read - can pull, but not push to or administer this repository. * write - can pull and push, but not administer this repository. * admin - can pull, push, and administer this repository. * none - no permissions granted by default.

  • Optional description?: string

    The description of the company.

  • Optional email?: string

    The publicly visible email address.

  • Optional has_organization_projects?: boolean

    Toggles whether an organization can use organization projects.

  • Optional has_repository_projects?: boolean

    Toggles whether repositories that belong to the organization can use repository projects.

  • Optional location?: string

    The location.

  • Optional members_allowed_repository_creation_type?: "all" | "private" | "none"

    Specifies which types of repositories non-admin organization members can create. Can be one of: * all - all organization members can create public and private repositories. * private - members can create private repositories. This option is only available to repositories that are part of an organization on GitHub Enterprise Cloud. * none - only admin members can create repositories. Note: This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in members_can_create_repositories. See this note for details.

  • Optional members_can_create_internal_repositories?: boolean

    Toggles whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. Can be one of: * true - all organization members can create internal repositories. * false - only organization owners can create internal repositories. Default: true. For more information, see "Restricting repository creation in your organization" in the GitHub Help documentation.

  • Optional members_can_create_private_repositories?: boolean

    Toggles whether organization members can create private repositories, which are visible to organization members with permission. Can be one of: * true - all organization members can create private repositories. * false - only organization owners can create private repositories. Default: true. For more information, see "Restricting repository creation in your organization" in the GitHub Help documentation.

  • Optional members_can_create_public_repositories?: boolean

    Toggles whether organization members can create public repositories, which are visible to anyone. Can be one of: * true - all organization members can create public repositories. * false - only organization owners can create public repositories. Default: true. For more information, see "Restricting repository creation in your organization" in the GitHub Help documentation.

  • Optional members_can_create_repositories?: boolean

    Toggles the ability of non-admin organization members to create repositories. Can be one of: * true - all organization members can create repositories. * false - only organization owners can create repositories. Default: true Note: A parameter can override this parameter. See members_allowed_repository_creation_type in this table for details. Note: A parameter can override this parameter. See members_allowed_repository_creation_type in this table for details.

  • Optional name?: string

    The shorthand name of the company.

  • org: string

    org parameter

OrgsUpdateHookEndpoint

OrgsUpdateHookEndpoint: { active?: boolean; config?: OrgsUpdateHookParamsConfig; events?: string[]; hook_id: number; org: string }

Type declaration

  • Optional active?: boolean

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

  • Optional config?: OrgsUpdateHookParamsConfig

    Key/value pairs to provide settings for this webhook. These are defined below.

  • Optional events?: string[]

    Determines what events the hook is triggered for.

  • hook_id: number

    hook_id parameter

  • org: string

    org parameter

OrgsUpdateHookParamsConfig

OrgsUpdateHookParamsConfig: { content_type?: string; insecure_ssl?: string; secret?: string; url: string }

Type declaration

  • Optional content_type?: string
  • Optional insecure_ssl?: string
  • Optional secret?: string
  • url: string

OrgsUpdateHookRequestOptions

OrgsUpdateHookRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

OrgsUpdateMembershipEndpoint

OrgsUpdateMembershipEndpoint: { org: string; state: "active" }

Type declaration

  • org: string

    org parameter

  • state: "active"

    The state that the membership should be in. Only "active" will be accepted.

OrgsUpdateMembershipRequestOptions

OrgsUpdateMembershipRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

OrgsUpdateRequestOptions

OrgsUpdateRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

ProjectsAddCollaboratorEndpoint

ProjectsAddCollaboratorEndpoint: { permission?: "read" | "write" | "admin"; project_id: number; username: string }

Type declaration

  • Optional permission?: "read" | "write" | "admin"

    The permission to grant the collaborator. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs." Can be one of: * read - can read, but not write to or administer this project. * write - can read and write, but not administer this project. * admin - can read, write and administer this project.

  • project_id: number

    project_id parameter

  • username: string

    username parameter

ProjectsAddCollaboratorRequestOptions

ProjectsAddCollaboratorRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

ProjectsCreateCardEndpoint

ProjectsCreateCardEndpoint: { column_id: number; content_id?: number; content_type?: string; note?: string }

Type declaration

  • column_id: number

    column_id parameter

  • Optional content_id?: number

    The issue or pull request id you want to associate with this card. You can use the List repository issues and List pull requests endpoints to find this id. Note: Depending on whether you use the issue id or pull request id, you will need to specify Issue or PullRequest as the content_type.

  • Optional content_type?: string

    Required if you provide content_id. The type of content you want to associate with this card. Use Issue when content_id is an issue id and use PullRequest when content_id is a pull request id.

  • Optional note?: string

    The card's note content. Only valid for cards without another type of content, so you must omit when specifying content_id and content_type.

ProjectsCreateCardRequestOptions

ProjectsCreateCardRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ProjectsCreateColumnEndpoint

ProjectsCreateColumnEndpoint: { name: string; project_id: number }

Type declaration

  • name: string

    The name of the column.

  • project_id: number

    project_id parameter

ProjectsCreateColumnRequestOptions

ProjectsCreateColumnRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ProjectsCreateForAuthenticatedUserEndpoint

ProjectsCreateForAuthenticatedUserEndpoint: { body?: string; name: string }

Type declaration

  • Optional body?: string

    The description of the project.

  • name: string

    The name of the project.

ProjectsCreateForAuthenticatedUserRequestOptions

ProjectsCreateForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ProjectsCreateForOrgEndpoint

ProjectsCreateForOrgEndpoint: { body?: string; name: string; org: string }

Type declaration

  • Optional body?: string

    The description of the project.

  • name: string

    The name of the project.

  • org: string

    org parameter

ProjectsCreateForOrgRequestOptions

ProjectsCreateForOrgRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ProjectsCreateForRepoEndpoint

ProjectsCreateForRepoEndpoint: { body?: string; name: string; owner: string; repo: string }

Type declaration

  • Optional body?: string

    The description of the project.

  • name: string

    The name of the project.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ProjectsCreateForRepoRequestOptions

ProjectsCreateForRepoRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ProjectsDeleteCardEndpoint

ProjectsDeleteCardEndpoint: { card_id: number }

Type declaration

  • card_id: number

    card_id parameter

ProjectsDeleteCardRequestOptions

ProjectsDeleteCardRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ProjectsDeleteColumnEndpoint

ProjectsDeleteColumnEndpoint: { column_id: number }

Type declaration

  • column_id: number

    column_id parameter

ProjectsDeleteColumnRequestOptions

ProjectsDeleteColumnRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ProjectsDeleteEndpoint

ProjectsDeleteEndpoint: { project_id: number }

Type declaration

  • project_id: number

    project_id parameter

ProjectsDeleteRequestOptions

ProjectsDeleteRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ProjectsGetCardEndpoint

ProjectsGetCardEndpoint: { card_id: number }

Type declaration

  • card_id: number

    card_id parameter

ProjectsGetCardRequestOptions

ProjectsGetCardRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ProjectsGetColumnEndpoint

ProjectsGetColumnEndpoint: { column_id: number }

Type declaration

  • column_id: number

    column_id parameter

ProjectsGetColumnRequestOptions

ProjectsGetColumnRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ProjectsGetEndpoint

ProjectsGetEndpoint: { project_id: number }

Type declaration

  • project_id: number

    project_id parameter

ProjectsGetRequestOptions

ProjectsGetRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ProjectsListCardsEndpoint

ProjectsListCardsEndpoint: { archived_state?: "all" | "archived" | "not_archived"; column_id: number; page?: number; per_page?: number }

Type declaration

  • Optional archived_state?: "all" | "archived" | "not_archived"

    Filters the project cards that are returned by the card's state. Can be one of all,archived, or not_archived.

  • column_id: number

    column_id parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

ProjectsListCardsRequestOptions

ProjectsListCardsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ProjectsListCollaboratorsEndpoint

ProjectsListCollaboratorsEndpoint: { affiliation?: "outside" | "direct" | "all"; page?: number; per_page?: number; project_id: number }

Type declaration

  • Optional affiliation?: "outside" | "direct" | "all"

    Filters the collaborators by their affiliation. Can be one of: * outside: Outside collaborators of a project that are not a member of the project's organization. * direct: Collaborators with permissions to a project, regardless of organization membership status. * all: All collaborators the authenticated user can see.

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • project_id: number

    project_id parameter

ProjectsListCollaboratorsRequestOptions

ProjectsListCollaboratorsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ProjectsListColumnsEndpoint

ProjectsListColumnsEndpoint: { page?: number; per_page?: number; project_id: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • project_id: number

    project_id parameter

ProjectsListColumnsRequestOptions

ProjectsListColumnsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ProjectsListForOrgEndpoint

ProjectsListForOrgEndpoint: { org: string; page?: number; per_page?: number; state?: "open" | "closed" | "all" }

Type declaration

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional state?: "open" | "closed" | "all"

    Indicates the state of the projects to return. Can be either open, closed, or all.

ProjectsListForOrgRequestOptions

ProjectsListForOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ProjectsListForRepoEndpoint

ProjectsListForRepoEndpoint: { owner: string; page?: number; per_page?: number; repo: string; state?: "open" | "closed" | "all" }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

  • Optional state?: "open" | "closed" | "all"

    Indicates the state of the projects to return. Can be either open, closed, or all.

ProjectsListForRepoRequestOptions

ProjectsListForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ProjectsListForUserEndpoint

ProjectsListForUserEndpoint: { page?: number; per_page?: number; state?: "open" | "closed" | "all"; username: string }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional state?: "open" | "closed" | "all"

    Indicates the state of the projects to return. Can be either open, closed, or all.

  • username: string

    username parameter

ProjectsListForUserRequestOptions

ProjectsListForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ProjectsMoveCardEndpoint

ProjectsMoveCardEndpoint: { card_id: number; column_id?: number; position: string }

Type declaration

  • card_id: number

    card_id parameter

  • Optional column_id?: number

    The id value of a column in the same project.

  • position: string

    Can be one of top, bottom, or after:<card_id>, where <card_id> is the id value of a card in the same column, or in the new column specified by column_id.

ProjectsMoveCardRequestOptions

ProjectsMoveCardRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ProjectsMoveColumnEndpoint

ProjectsMoveColumnEndpoint: { column_id: number; position: string }

Type declaration

  • column_id: number

    column_id parameter

  • position: string

    Can be one of first, last, or after:<column_id>, where <column_id> is the id value of a column in the same project.

ProjectsMoveColumnRequestOptions

ProjectsMoveColumnRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ProjectsRemoveCollaboratorEndpoint

ProjectsRemoveCollaboratorEndpoint: { project_id: number; username: string }

Type declaration

  • project_id: number

    project_id parameter

  • username: string

    username parameter

ProjectsRemoveCollaboratorRequestOptions

ProjectsRemoveCollaboratorRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ProjectsReviewUserPermissionLevelEndpoint

ProjectsReviewUserPermissionLevelEndpoint: { project_id: number; username: string }

Type declaration

  • project_id: number

    project_id parameter

  • username: string

    username parameter

ProjectsReviewUserPermissionLevelRequestOptions

ProjectsReviewUserPermissionLevelRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ProjectsUpdateCardEndpoint

ProjectsUpdateCardEndpoint: { archived?: boolean; card_id: number; note?: string }

Type declaration

  • Optional archived?: boolean

    Use true to archive a project card. Specify false if you need to restore a previously archived project card.

  • card_id: number

    card_id parameter

  • Optional note?: string

    The card's note content. Only valid for cards without another type of content, so this cannot be specified if the card already has a content_id and content_type.

ProjectsUpdateCardRequestOptions

ProjectsUpdateCardRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

ProjectsUpdateColumnEndpoint

ProjectsUpdateColumnEndpoint: { column_id: number; name: string }

Type declaration

  • column_id: number

    column_id parameter

  • name: string

    The new name of the column.

ProjectsUpdateColumnRequestOptions

ProjectsUpdateColumnRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

ProjectsUpdateEndpoint

ProjectsUpdateEndpoint: { body?: string; name?: string; organization_permission?: string; private?: boolean; project_id: number; state?: "open" | "closed" }

Type declaration

  • Optional body?: string

    The description of the project.

  • Optional name?: string

    The name of the project.

  • Optional organization_permission?: string

    The permission level that determines whether all members of the project's organization can see and/or make changes to the project. Setting organization_permission is only available for organization projects. If an organization member belongs to a team with a higher level of access or is a collaborator with a higher level of access, their permission level is not lowered by organization_permission. For information on changing access for a team or collaborator, see Add or update team project or Add user as a collaborator.

    Note: Updating a project's organization_permission requires admin access to the project.

    Can be one of: * read - Organization members can read, but not write to or administer this project. * write - Organization members can read and write, but not administer this project. * admin - Organization members can read, write and administer this project. * none - Organization members can only see this project if it is public.

  • Optional private?: boolean

    Sets the visibility of a project board. Setting private is only available for organization and user projects. Note: Updating a project's visibility requires admin access to the project.

    Can be one of: * false - Anyone can see the project. * true - Only the user can view a project board created on a user account. Organization members with the appropriate organization_permission can see project boards in an organization account.

  • project_id: number

    project_id parameter

  • Optional state?: "open" | "closed"

    State of the project. Either open or closed.

ProjectsUpdateRequestOptions

ProjectsUpdateRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

PullsCheckIfMergedEndpoint

PullsCheckIfMergedEndpoint: { owner: string; pull_number: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • pull_number: number

    pull_number parameter

  • repo: string

    repo parameter

PullsCheckIfMergedRequestOptions

PullsCheckIfMergedRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

PullsCreateCommentEndpoint

PullsCreateCommentEndpoint: { body: string; commit_id: string; line?: number; owner: string; path: string; position?: number; pull_number: number; repo: string; side?: "LEFT" | "RIGHT"; start_line?: number; start_side?: "LEFT" | "RIGHT" | "side" }

Type declaration

  • body: string

    The text of the review comment.

  • commit_id: string

    The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the position.

  • Optional line?: number

    Required with comfort-fade preview. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

  • owner: string

    owner parameter

  • path: string

    The relative path to the file that necessitates a comment.

  • Optional position?: number

    Required without comfort-fade preview. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

  • pull_number: number

    pull_number parameter

  • repo: string

    repo parameter

  • Optional side?: "LEFT" | "RIGHT"

    Required with comfort-fade preview. In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "Diff view options" in the GitHub Help documentation.

  • Optional start_line?: number

    Required when using multi-line comments. To create multi-line comments, you must use the comfort-fade preview header. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "Commenting on a pull request" in the GitHub Help documentation.

  • Optional start_side?: "LEFT" | "RIGHT" | "side"

    Required when using multi-line comments. To create multi-line comments, you must use the comfort-fade preview header. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see "Commenting on a pull request" in the GitHub Help documentation. See side in this table for additional context.

PullsCreateCommentReplyEndpoint

PullsCreateCommentReplyEndpoint: { body: string; commit_id: string; line?: number; owner: string; path: string; position?: number; pull_number: number; repo: string; side?: "LEFT" | "RIGHT"; start_line?: number; start_side?: "LEFT" | "RIGHT" | "side" }

Type declaration

  • body: string

    The text of the review comment.

  • commit_id: string

    The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the position.

  • Optional line?: number

    Required with comfort-fade preview. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

  • owner: string

    owner parameter

  • path: string

    The relative path to the file that necessitates a comment.

  • Optional position?: number

    Required without comfort-fade preview. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

  • pull_number: number

    pull_number parameter

  • repo: string

    repo parameter

  • Optional side?: "LEFT" | "RIGHT"

    Required with comfort-fade preview. In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "Diff view options" in the GitHub Help documentation.

  • Optional start_line?: number

    Required when using multi-line comments. To create multi-line comments, you must use the comfort-fade preview header. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "Commenting on a pull request" in the GitHub Help documentation.

  • Optional start_side?: "LEFT" | "RIGHT" | "side"

    Required when using multi-line comments. To create multi-line comments, you must use the comfort-fade preview header. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see "Commenting on a pull request" in the GitHub Help documentation. See side in this table for additional context.

PullsCreateCommentReplyRequestOptions

PullsCreateCommentReplyRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

PullsCreateCommentRequestOptions

PullsCreateCommentRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

PullsCreateEndpoint

PullsCreateEndpoint: { base: string; body?: string; draft?: boolean; head: string; maintainer_can_modify?: boolean; owner: string; repo: string; title: string }

Type declaration

  • base: string

    The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.

  • Optional body?: string

    The contents of the pull request.

  • Optional draft?: boolean

    Indicates whether the pull request is a draft. See "Draft Pull Requests" in the GitHub Help documentation to learn more.

  • head: string

    The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch.

  • Optional maintainer_can_modify?: boolean

    Indicates whether maintainers can modify the pull request.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • title: string

    The title of the new pull request.

PullsCreateRequestOptions

PullsCreateRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

PullsCreateReviewCommentReplyEndpoint

PullsCreateReviewCommentReplyEndpoint: { body: string; comment_id: number; owner: string; pull_number: number; repo: string }

Type declaration

  • body: string

    The text of the review comment.

  • comment_id: number

    comment_id parameter

  • owner: string

    owner parameter

  • pull_number: number

    pull_number parameter

  • repo: string

    repo parameter

PullsCreateReviewCommentReplyRequestOptions

PullsCreateReviewCommentReplyRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

PullsCreateReviewEndpoint

PullsCreateReviewEndpoint: { body?: string; comments?: PullsCreateReviewParamsComments[]; commit_id?: string; event?: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; owner: string; pull_number: number; repo: string }

Type declaration

  • Optional body?: string

    Required when using REQUEST_CHANGES or COMMENT for the event parameter. The body text of the pull request review.

  • Optional comments?: PullsCreateReviewParamsComments[]

    Use the following table to specify the location, destination, and contents of the draft review comment.

  • Optional commit_id?: string

    The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the position. Defaults to the most recent commit in the pull request when you do not specify a value.

  • Optional event?: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"

    The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. By leaving this blank, you set the review action state to PENDING, which means you will need to submit the pull request review when you are ready.

  • owner: string

    owner parameter

  • pull_number: number

    pull_number parameter

  • repo: string

    repo parameter

PullsCreateReviewParamsComments

PullsCreateReviewParamsComments: { body: string; path: string; position: number }

Type declaration

  • body: string
  • path: string
  • position: number

PullsCreateReviewRequestEndpoint

PullsCreateReviewRequestEndpoint: { owner: string; pull_number: number; repo: string; reviewers?: string[]; team_reviewers?: string[] }

Type declaration

  • owner: string

    owner parameter

  • pull_number: number

    pull_number parameter

  • repo: string

    repo parameter

  • Optional reviewers?: string[]

    An array of user logins that will be requested.

  • Optional team_reviewers?: string[]

    An array of team slugs that will be requested.

PullsCreateReviewRequestOptions

PullsCreateReviewRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

PullsCreateReviewRequestRequestOptions

PullsCreateReviewRequestRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

PullsDeleteCommentEndpoint

PullsDeleteCommentEndpoint: { comment_id: number; owner: string; repo: string }

Type declaration

  • comment_id: number

    comment_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

PullsDeleteCommentRequestOptions

PullsDeleteCommentRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

PullsDeletePendingReviewEndpoint

PullsDeletePendingReviewEndpoint: { owner: string; pull_number: number; repo: string; review_id: number }

Type declaration

  • owner: string

    owner parameter

  • pull_number: number

    pull_number parameter

  • repo: string

    repo parameter

  • review_id: number

    review_id parameter

PullsDeletePendingReviewRequestOptions

PullsDeletePendingReviewRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

PullsDeleteReviewRequestEndpoint

PullsDeleteReviewRequestEndpoint: { owner: string; pull_number: number; repo: string; reviewers?: string[]; team_reviewers?: string[] }

Type declaration

  • owner: string

    owner parameter

  • pull_number: number

    pull_number parameter

  • repo: string

    repo parameter

  • Optional reviewers?: string[]

    An array of user logins that will be removed.

  • Optional team_reviewers?: string[]

    An array of team slugs that will be removed.

PullsDeleteReviewRequestRequestOptions

PullsDeleteReviewRequestRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

PullsDismissReviewEndpoint

PullsDismissReviewEndpoint: { message: string; owner: string; pull_number: number; repo: string; review_id: number }

Type declaration

  • message: string

    The message for the pull request review dismissal

  • owner: string

    owner parameter

  • pull_number: number

    pull_number parameter

  • repo: string

    repo parameter

  • review_id: number

    review_id parameter

PullsDismissReviewRequestOptions

PullsDismissReviewRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

PullsGetCommentEndpoint

PullsGetCommentEndpoint: { comment_id: number; owner: string; repo: string }

Type declaration

  • comment_id: number

    comment_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

PullsGetCommentRequestOptions

PullsGetCommentRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

PullsGetCommentsForReviewEndpoint

PullsGetCommentsForReviewEndpoint: { owner: string; page?: number; per_page?: number; pull_number: number; repo: string; review_id: number }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • pull_number: number

    pull_number parameter

  • repo: string

    repo parameter

  • review_id: number

    review_id parameter

PullsGetCommentsForReviewRequestOptions

PullsGetCommentsForReviewRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

PullsGetEndpoint

PullsGetEndpoint: { owner: string; pull_number: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • pull_number: number

    pull_number parameter

  • repo: string

    repo parameter

PullsGetRequestOptions

PullsGetRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

PullsGetReviewEndpoint

PullsGetReviewEndpoint: { owner: string; pull_number: number; repo: string; review_id: number }

Type declaration

  • owner: string

    owner parameter

  • pull_number: number

    pull_number parameter

  • repo: string

    repo parameter

  • review_id: number

    review_id parameter

PullsGetReviewRequestOptions

PullsGetReviewRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

PullsListCommentsEndpoint

PullsListCommentsEndpoint: { direction?: "asc" | "desc"; owner: string; page?: number; per_page?: number; pull_number: number; repo: string; since?: string; sort?: "created" | "updated" }

Type declaration

  • Optional direction?: "asc" | "desc"

    Can be either asc or desc. Ignored without sort parameter.

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • pull_number: number

    pull_number parameter

  • repo: string

    repo parameter

  • Optional since?: string

    This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only returns comments updated at or after this time.

  • Optional sort?: "created" | "updated"

    Can be either created or updated comments.

PullsListCommentsForRepoEndpoint

PullsListCommentsForRepoEndpoint: { direction?: "asc" | "desc"; owner: string; page?: number; per_page?: number; repo: string; since?: string; sort?: "created" | "updated" }

Type declaration

  • Optional direction?: "asc" | "desc"

    Can be either asc or desc. Ignored without sort parameter.

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

  • Optional since?: string

    This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only returns comments updated at or after this time.

  • Optional sort?: "created" | "updated"

    Can be either created or updated comments.

PullsListCommentsForRepoRequestOptions

PullsListCommentsForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

PullsListCommentsRequestOptions

PullsListCommentsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

PullsListCommitsEndpoint

PullsListCommitsEndpoint: { owner: string; page?: number; per_page?: number; pull_number: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • pull_number: number

    pull_number parameter

  • repo: string

    repo parameter

PullsListCommitsRequestOptions

PullsListCommitsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

PullsListEndpoint

PullsListEndpoint: { base?: string; direction?: "asc" | "desc"; head?: string; owner: string; page?: number; per_page?: number; repo: string; sort?: "created" | "updated" | "popularity" | "long-running"; state?: "open" | "closed" | "all" }

Type declaration

  • Optional base?: string

    Filter pulls by base branch name. Example: gh-pages.

  • Optional direction?: "asc" | "desc"

    The direction of the sort. Can be either asc or desc. Default: desc when sort is created or sort is not specified, otherwise asc.

  • Optional head?: string

    Filter pulls by head user or head organization and branch name in the format of user:ref-name or organization:ref-name. For example: github:new-script-format or octocat:test-branch.

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

  • Optional sort?: "created" | "updated" | "popularity" | "long-running"

    What to sort results by. Can be either created, updated, popularity (comment count) or long-running (age, filtering by pulls updated in the last month).

  • Optional state?: "open" | "closed" | "all"

    Either open, closed, or all to filter by state.

PullsListFilesEndpoint

PullsListFilesEndpoint: { owner: string; page?: number; per_page?: number; pull_number: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • pull_number: number

    pull_number parameter

  • repo: string

    repo parameter

PullsListFilesRequestOptions

PullsListFilesRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

PullsListRequestOptions

PullsListRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

PullsListReviewRequestsEndpoint

PullsListReviewRequestsEndpoint: { owner: string; page?: number; per_page?: number; pull_number: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • pull_number: number

    pull_number parameter

  • repo: string

    repo parameter

PullsListReviewRequestsRequestOptions

PullsListReviewRequestsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

PullsListReviewsEndpoint

PullsListReviewsEndpoint: { owner: string; page?: number; per_page?: number; pull_number: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • pull_number: number

    pull_number parameter

  • repo: string

    repo parameter

PullsListReviewsRequestOptions

PullsListReviewsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

PullsMergeEndpoint

PullsMergeEndpoint: { commit_message?: string; commit_title?: string; merge_method?: "merge" | "squash" | "rebase"; owner: string; pull_number: number; repo: string; sha?: string }

Type declaration

  • Optional commit_message?: string

    Extra detail to append to automatic commit message.

  • Optional commit_title?: string

    Title for the automatic commit message.

  • Optional merge_method?: "merge" | "squash" | "rebase"

    Merge method to use. Possible values are merge, squash or rebase. Default is merge.

  • owner: string

    owner parameter

  • pull_number: number

    pull_number parameter

  • repo: string

    repo parameter

  • Optional sha?: string

    SHA that pull request head must match to allow merge.

PullsMergeRequestOptions

PullsMergeRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

PullsSubmitReviewEndpoint

PullsSubmitReviewEndpoint: { body?: string; event: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; owner: string; pull_number: number; repo: string; review_id: number }

Type declaration

  • Optional body?: string

    The body text of the pull request review

  • event: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"

    The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. When you leave this blank, the API returns HTTP 422 (Unrecognizable entity) and sets the review action state to PENDING, which means you will need to re-submit the pull request review using a review action.

  • owner: string

    owner parameter

  • pull_number: number

    pull_number parameter

  • repo: string

    repo parameter

  • review_id: number

    review_id parameter

PullsSubmitReviewRequestOptions

PullsSubmitReviewRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

PullsUpdateBranchEndpoint

PullsUpdateBranchEndpoint: { expected_head_sha?: string; owner: string; pull_number: number; repo: string }

Type declaration

  • Optional expected_head_sha?: string

    The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a 422 Unprocessable Entity status. You can use the "List commits on a repository" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.

  • owner: string

    owner parameter

  • pull_number: number

    pull_number parameter

  • repo: string

    repo parameter

PullsUpdateBranchRequestOptions

PullsUpdateBranchRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

PullsUpdateCommentEndpoint

PullsUpdateCommentEndpoint: { body: string; comment_id: number; owner: string; repo: string }

Type declaration

  • body: string

    The text of the reply to the review comment.

  • comment_id: number

    comment_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

PullsUpdateCommentRequestOptions

PullsUpdateCommentRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

PullsUpdateEndpoint

PullsUpdateEndpoint: { base?: string; body?: string; maintainer_can_modify?: boolean; owner: string; pull_number: number; repo: string; state?: "open" | "closed"; title?: string }

Type declaration

  • Optional base?: string

    The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.

  • Optional body?: string

    The contents of the pull request.

  • Optional maintainer_can_modify?: boolean

    Indicates whether maintainers can modify the pull request.

  • owner: string

    owner parameter

  • pull_number: number

    pull_number parameter

  • repo: string

    repo parameter

  • Optional state?: "open" | "closed"

    State of this Pull Request. Either open or closed.

  • Optional title?: string

    The title of the pull request.

PullsUpdateRequestOptions

PullsUpdateRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

PullsUpdateReviewEndpoint

PullsUpdateReviewEndpoint: { body: string; owner: string; pull_number: number; repo: string; review_id: number }

Type declaration

  • body: string

    The body text of the pull request review.

  • owner: string

    owner parameter

  • pull_number: number

    pull_number parameter

  • repo: string

    repo parameter

  • review_id: number

    review_id parameter

PullsUpdateReviewRequestOptions

PullsUpdateReviewRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

RateLimitGetEndpoint

RateLimitGetEndpoint: {}

Type declaration

RateLimitGetRequestOptions

RateLimitGetRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReactionsCreateForCommitCommentEndpoint

ReactionsCreateForCommitCommentEndpoint: { comment_id: number; content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; owner: string; repo: string }

Type declaration

  • comment_id: number

    comment_id parameter

  • content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    The reaction type to add to the commit comment.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReactionsCreateForCommitCommentRequestOptions

ReactionsCreateForCommitCommentRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ReactionsCreateForIssueCommentEndpoint

ReactionsCreateForIssueCommentEndpoint: { comment_id: number; content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; owner: string; repo: string }

Type declaration

  • comment_id: number

    comment_id parameter

  • content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    The reaction type to add to the issue comment.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReactionsCreateForIssueCommentRequestOptions

ReactionsCreateForIssueCommentRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ReactionsCreateForIssueEndpoint

ReactionsCreateForIssueEndpoint: { content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; issue_number: number; owner: string; repo: string }

Type declaration

  • content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    The reaction type to add to the issue.

  • issue_number: number

    issue_number parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReactionsCreateForIssueRequestOptions

ReactionsCreateForIssueRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ReactionsCreateForPullRequestReviewCommentEndpoint

ReactionsCreateForPullRequestReviewCommentEndpoint: { comment_id: number; content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; owner: string; repo: string }

Type declaration

  • comment_id: number

    comment_id parameter

  • content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    The reaction type to add to the pull request review comment.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReactionsCreateForPullRequestReviewCommentRequestOptions

ReactionsCreateForPullRequestReviewCommentRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ReactionsCreateForTeamDiscussionCommentEndpoint

ReactionsCreateForTeamDiscussionCommentEndpoint: { comment_number: number; content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; discussion_number: number; team_id: number }

Type declaration

  • comment_number: number

    comment_number parameter

  • content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    The reaction type to add to the team discussion comment.

  • discussion_number: number

    discussion_number parameter

  • team_id: number

    team_id parameter

ReactionsCreateForTeamDiscussionCommentInOrgEndpoint

ReactionsCreateForTeamDiscussionCommentInOrgEndpoint: { comment_number: number; content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; discussion_number: number; org: string; team_slug: string }

Type declaration

  • comment_number: number

    comment_number parameter

  • content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    The reaction type to add to the team discussion comment.

  • discussion_number: number

    discussion_number parameter

  • org: string

    org parameter

  • team_slug: string

    team_slug parameter

ReactionsCreateForTeamDiscussionCommentInOrgRequestOptions

ReactionsCreateForTeamDiscussionCommentInOrgRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ReactionsCreateForTeamDiscussionCommentLegacyEndpoint

ReactionsCreateForTeamDiscussionCommentLegacyEndpoint: { comment_number: number; content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; discussion_number: number; team_id: number }

Type declaration

  • comment_number: number

    comment_number parameter

  • content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    The reaction type to add to the team discussion comment.

  • discussion_number: number

    discussion_number parameter

  • team_id: number

    team_id parameter

ReactionsCreateForTeamDiscussionCommentLegacyRequestOptions

ReactionsCreateForTeamDiscussionCommentLegacyRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ReactionsCreateForTeamDiscussionCommentRequestOptions

ReactionsCreateForTeamDiscussionCommentRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ReactionsCreateForTeamDiscussionEndpoint

ReactionsCreateForTeamDiscussionEndpoint: { content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; discussion_number: number; team_id: number }

Type declaration

  • content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    The reaction type to add to the team discussion.

  • discussion_number: number

    discussion_number parameter

  • team_id: number

    team_id parameter

ReactionsCreateForTeamDiscussionInOrgEndpoint

ReactionsCreateForTeamDiscussionInOrgEndpoint: { content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; discussion_number: number; org: string; team_slug: string }

Type declaration

  • content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    The reaction type to add to the team discussion.

  • discussion_number: number

    discussion_number parameter

  • org: string

    org parameter

  • team_slug: string

    team_slug parameter

ReactionsCreateForTeamDiscussionInOrgRequestOptions

ReactionsCreateForTeamDiscussionInOrgRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ReactionsCreateForTeamDiscussionLegacyEndpoint

ReactionsCreateForTeamDiscussionLegacyEndpoint: { content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; discussion_number: number; team_id: number }

Type declaration

  • content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    The reaction type to add to the team discussion.

  • discussion_number: number

    discussion_number parameter

  • team_id: number

    team_id parameter

ReactionsCreateForTeamDiscussionLegacyRequestOptions

ReactionsCreateForTeamDiscussionLegacyRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ReactionsCreateForTeamDiscussionRequestOptions

ReactionsCreateForTeamDiscussionRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ReactionsDeleteEndpoint

ReactionsDeleteEndpoint: { reaction_id: number }

Type declaration

  • reaction_id: number

    reaction_id parameter

ReactionsDeleteForCommitCommentEndpoint

ReactionsDeleteForCommitCommentEndpoint: { comment_id: number; owner: string; reaction_id: number; repo: string }

Type declaration

  • comment_id: number

    comment_id parameter

  • owner: string

    owner parameter

  • reaction_id: number

    reaction_id parameter

  • repo: string

    repo parameter

ReactionsDeleteForCommitCommentRequestOptions

ReactionsDeleteForCommitCommentRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ReactionsDeleteForIssueCommentEndpoint

ReactionsDeleteForIssueCommentEndpoint: { comment_id: number; owner: string; reaction_id: number; repo: string }

Type declaration

  • comment_id: number

    comment_id parameter

  • owner: string

    owner parameter

  • reaction_id: number

    reaction_id parameter

  • repo: string

    repo parameter

ReactionsDeleteForIssueCommentRequestOptions

ReactionsDeleteForIssueCommentRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ReactionsDeleteForIssueEndpoint

ReactionsDeleteForIssueEndpoint: { issue_number: number; owner: string; reaction_id: number; repo: string }

Type declaration

  • issue_number: number

    issue_number parameter

  • owner: string

    owner parameter

  • reaction_id: number

    reaction_id parameter

  • repo: string

    repo parameter

ReactionsDeleteForIssueRequestOptions

ReactionsDeleteForIssueRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ReactionsDeleteForPullRequestCommentEndpoint

ReactionsDeleteForPullRequestCommentEndpoint: { comment_id: number; owner: string; reaction_id: number; repo: string }

Type declaration

  • comment_id: number

    comment_id parameter

  • owner: string

    owner parameter

  • reaction_id: number

    reaction_id parameter

  • repo: string

    repo parameter

ReactionsDeleteForPullRequestCommentRequestOptions

ReactionsDeleteForPullRequestCommentRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ReactionsDeleteForTeamDiscussionCommentEndpoint

ReactionsDeleteForTeamDiscussionCommentEndpoint: { comment_number: number; discussion_number: number; org: string; reaction_id: number; team_slug: string }

Type declaration

  • comment_number: number

    comment_number parameter

  • discussion_number: number

    discussion_number parameter

  • org: string

    org parameter

  • reaction_id: number

    reaction_id parameter

  • team_slug: string

    team_slug parameter

ReactionsDeleteForTeamDiscussionCommentRequestOptions

ReactionsDeleteForTeamDiscussionCommentRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ReactionsDeleteForTeamDiscussionEndpoint

ReactionsDeleteForTeamDiscussionEndpoint: { discussion_number: number; org: string; reaction_id: number; team_slug: string }

Type declaration

  • discussion_number: number

    discussion_number parameter

  • org: string

    org parameter

  • reaction_id: number

    reaction_id parameter

  • team_slug: string

    team_slug parameter

ReactionsDeleteForTeamDiscussionRequestOptions

ReactionsDeleteForTeamDiscussionRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ReactionsDeleteLegacyEndpoint

ReactionsDeleteLegacyEndpoint: { reaction_id: number }

Type declaration

  • reaction_id: number

    reaction_id parameter

ReactionsDeleteLegacyRequestOptions

ReactionsDeleteLegacyRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ReactionsDeleteRequestOptions

ReactionsDeleteRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ReactionsListForCommitCommentEndpoint

ReactionsListForCommitCommentEndpoint: { comment_id: number; content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • comment_id: number

    comment_id parameter

  • Optional content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    Returns a single reaction type. Omit this parameter to list all reactions to a commit comment.

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ReactionsListForCommitCommentRequestOptions

ReactionsListForCommitCommentRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReactionsListForIssueCommentEndpoint

ReactionsListForIssueCommentEndpoint: { comment_id: number; content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • comment_id: number

    comment_id parameter

  • Optional content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    Returns a single reaction type. Omit this parameter to list all reactions to an issue comment.

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ReactionsListForIssueCommentRequestOptions

ReactionsListForIssueCommentRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReactionsListForIssueEndpoint

ReactionsListForIssueEndpoint: { content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; issue_number: number; owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • Optional content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    Returns a single reaction type. Omit this parameter to list all reactions to an issue.

  • issue_number: number

    issue_number parameter

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ReactionsListForIssueRequestOptions

ReactionsListForIssueRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReactionsListForPullRequestReviewCommentEndpoint

ReactionsListForPullRequestReviewCommentEndpoint: { comment_id: number; content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • comment_id: number

    comment_id parameter

  • Optional content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    Returns a single reaction type. Omit this parameter to list all reactions to a pull request review comment.

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ReactionsListForPullRequestReviewCommentRequestOptions

ReactionsListForPullRequestReviewCommentRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReactionsListForTeamDiscussionCommentEndpoint

ReactionsListForTeamDiscussionCommentEndpoint: { comment_number: number; content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; discussion_number: number; page?: number; per_page?: number; team_id: number }

Type declaration

  • comment_number: number

    comment_number parameter

  • Optional content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.

  • discussion_number: number

    discussion_number parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • team_id: number

    team_id parameter

ReactionsListForTeamDiscussionCommentInOrgEndpoint

ReactionsListForTeamDiscussionCommentInOrgEndpoint: { comment_number: number; content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; discussion_number: number; org: string; page?: number; per_page?: number; team_slug: string }

Type declaration

  • comment_number: number

    comment_number parameter

  • Optional content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.

  • discussion_number: number

    discussion_number parameter

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • team_slug: string

    team_slug parameter

ReactionsListForTeamDiscussionCommentInOrgRequestOptions

ReactionsListForTeamDiscussionCommentInOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReactionsListForTeamDiscussionCommentLegacyEndpoint

ReactionsListForTeamDiscussionCommentLegacyEndpoint: { comment_number: number; content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; discussion_number: number; page?: number; per_page?: number; team_id: number }

Type declaration

  • comment_number: number

    comment_number parameter

  • Optional content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.

  • discussion_number: number

    discussion_number parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • team_id: number

    team_id parameter

ReactionsListForTeamDiscussionCommentLegacyRequestOptions

ReactionsListForTeamDiscussionCommentLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReactionsListForTeamDiscussionCommentRequestOptions

ReactionsListForTeamDiscussionCommentRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReactionsListForTeamDiscussionEndpoint

ReactionsListForTeamDiscussionEndpoint: { content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; discussion_number: number; page?: number; per_page?: number; team_id: number }

Type declaration

  • Optional content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.

  • discussion_number: number

    discussion_number parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • team_id: number

    team_id parameter

ReactionsListForTeamDiscussionInOrgEndpoint

ReactionsListForTeamDiscussionInOrgEndpoint: { content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; discussion_number: number; org: string; page?: number; per_page?: number; team_slug: string }

Type declaration

  • Optional content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.

  • discussion_number: number

    discussion_number parameter

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • team_slug: string

    team_slug parameter

ReactionsListForTeamDiscussionInOrgRequestOptions

ReactionsListForTeamDiscussionInOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReactionsListForTeamDiscussionLegacyEndpoint

ReactionsListForTeamDiscussionLegacyEndpoint: { content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; discussion_number: number; page?: number; per_page?: number; team_id: number }

Type declaration

  • Optional content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"

    Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.

  • discussion_number: number

    discussion_number parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • team_id: number

    team_id parameter

ReactionsListForTeamDiscussionLegacyRequestOptions

ReactionsListForTeamDiscussionLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReactionsListForTeamDiscussionRequestOptions

ReactionsListForTeamDiscussionRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposAcceptInvitationEndpoint

ReposAcceptInvitationEndpoint: { invitation_id: number }

Type declaration

  • invitation_id: number

    invitation_id parameter

ReposAcceptInvitationRequestOptions

ReposAcceptInvitationRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

ReposAddCollaboratorEndpoint

ReposAddCollaboratorEndpoint: { owner: string; permission?: "pull" | "push" | "admin" | "maintain" | "triage"; repo: string; username: string }

Type declaration

  • owner: string

    owner parameter

  • Optional permission?: "pull" | "push" | "admin" | "maintain" | "triage"

    The permission to grant the collaborator. Only valid on organization-owned repositories. Can be one of: * pull - can pull, but not push to or administer this repository. * push - can pull and push, but not administer this repository. * admin - can pull, push and administer this repository. * maintain - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. * triage - Recommended for contributors who need to proactively manage issues and pull requests without write access.

  • repo: string

    repo parameter

  • username: string

    username parameter

ReposAddCollaboratorRequestOptions

ReposAddCollaboratorRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

ReposAddDeployKeyEndpoint

ReposAddDeployKeyEndpoint: { key: string; owner: string; read_only?: boolean; repo: string; title?: string }

Type declaration

  • key: string

    The contents of the key.

  • owner: string

    owner parameter

  • Optional read_only?: boolean

    If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.

    Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "Repository permission levels for an organization" and "Permission levels for a user account repository."

  • repo: string

    repo parameter

  • Optional title?: string

    A name for the key.

ReposAddDeployKeyRequestOptions

ReposAddDeployKeyRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ReposAddProtectedBranchAdminEnforcementEndpoint

ReposAddProtectedBranchAdminEnforcementEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposAddProtectedBranchAdminEnforcementRequestOptions

ReposAddProtectedBranchAdminEnforcementRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ReposAddProtectedBranchAppRestrictionsEndpoint

ReposAddProtectedBranchAppRestrictionsEndpoint: { apps: string[]; branch: string; owner: string; repo: string }

Type declaration

  • apps: string[]

    apps parameter

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposAddProtectedBranchAppRestrictionsRequestOptions

ReposAddProtectedBranchAppRestrictionsRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ReposAddProtectedBranchRequiredSignaturesEndpoint

ReposAddProtectedBranchRequiredSignaturesEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposAddProtectedBranchRequiredSignaturesRequestOptions

ReposAddProtectedBranchRequiredSignaturesRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ReposAddProtectedBranchRequiredStatusChecksContextsEndpoint

ReposAddProtectedBranchRequiredStatusChecksContextsEndpoint: { branch: string; contexts: string[]; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • contexts: string[]

    contexts parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposAddProtectedBranchRequiredStatusChecksContextsRequestOptions

ReposAddProtectedBranchRequiredStatusChecksContextsRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ReposAddProtectedBranchTeamRestrictionsEndpoint

ReposAddProtectedBranchTeamRestrictionsEndpoint: { branch: string; owner: string; repo: string; teams: string[] }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • teams: string[]

    teams parameter

ReposAddProtectedBranchTeamRestrictionsRequestOptions

ReposAddProtectedBranchTeamRestrictionsRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ReposAddProtectedBranchUserRestrictionsEndpoint

ReposAddProtectedBranchUserRestrictionsEndpoint: { branch: string; owner: string; repo: string; users: string[] }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • users: string[]

    users parameter

ReposAddProtectedBranchUserRestrictionsRequestOptions

ReposAddProtectedBranchUserRestrictionsRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ReposCheckCollaboratorEndpoint

ReposCheckCollaboratorEndpoint: { owner: string; repo: string; username: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • username: string

    username parameter

ReposCheckCollaboratorRequestOptions

ReposCheckCollaboratorRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposCheckVulnerabilityAlertsEndpoint

ReposCheckVulnerabilityAlertsEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposCheckVulnerabilityAlertsRequestOptions

ReposCheckVulnerabilityAlertsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposCompareCommitsEndpoint

ReposCompareCommitsEndpoint: { base: string; head: string; owner: string; repo: string }

Type declaration

  • base: string

    base parameter

  • head: string

    head parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposCompareCommitsRequestOptions

ReposCompareCommitsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposCreateCommitCommentEndpoint

ReposCreateCommitCommentEndpoint: { body: string; commit_sha: string; line?: number; owner: string; path?: string; position?: number; repo: string }

Type declaration

  • body: string

    The contents of the comment.

  • commit_sha: string

    commit_sha parameter

  • Optional line?: number

    Deprecated. Use position parameter instead. Line number in the file to comment on.

  • owner: string

    owner parameter

  • Optional path?: string

    Relative path of the file to comment on.

  • Optional position?: number

    Line index in the diff to comment on.

  • repo: string

    repo parameter

ReposCreateCommitCommentRequestOptions

ReposCreateCommitCommentRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ReposCreateDeploymentEndpoint

ReposCreateDeploymentEndpoint: { auto_merge?: boolean; description?: string; environment?: string; owner: string; payload?: string; production_environment?: boolean; ref: string; repo: string; required_contexts?: string[]; task?: string; transient_environment?: boolean }

Type declaration

  • Optional auto_merge?: boolean

    Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.

  • Optional description?: string

    Short description of the deployment.

  • Optional environment?: string

    Name for the target deployment environment (e.g., production, staging, qa).

  • owner: string

    owner parameter

  • Optional payload?: string

    JSON payload with extra information about the deployment.

  • Optional production_environment?: boolean

    Specifies if the given environment is one that end-users directly interact with. Default: true when environment is production and false otherwise. Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

  • ref: string

    The ref to deploy. This can be a branch, tag, or SHA.

  • repo: string

    repo parameter

  • Optional required_contexts?: string[]

    The status contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.

  • Optional task?: string

    Specifies a task to execute (e.g., deploy or deploy:migrations).

  • Optional transient_environment?: boolean

    Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: false Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type. Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

ReposCreateDeploymentRequestOptions

ReposCreateDeploymentRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ReposCreateDeploymentStatusEndpoint

ReposCreateDeploymentStatusEndpoint: { auto_inactive?: boolean; deployment_id: number; description?: string; environment?: "production" | "staging" | "qa"; environment_url?: string; log_url?: string; owner: string; repo: string; state: "error" | "failure" | "inactive" | "in_progress" | "queued" | "pending" | "success"; target_url?: string }

Type declaration

  • Optional auto_inactive?: boolean

    Adds a new inactive status to all prior non-transient, non-production environment deployments with the same repository and environment name as the created status's deployment. An inactive status is only added to deployments that had a success state. Default: true Note: To add an inactive status to production environments, you must use the application/vnd.github.flash-preview+json custom media type. Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

  • deployment_id: number

    deployment_id parameter

  • Optional description?: string

    A short description of the status. The maximum description length is 140 characters.

  • Optional environment?: "production" | "staging" | "qa"

    Name for the target deployment environment, which can be changed when setting a deploy status. For example, production, staging, or qa. Note: This parameter requires you to use the application/vnd.github.flash-preview+json custom media type.

  • Optional environment_url?: string

    Sets the URL for accessing your environment. Default: "" Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type. Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

  • Optional log_url?: string

    The full URL of the deployment's output. This parameter replaces target_url. We will continue to accept target_url to support legacy uses, but we recommend replacing target_url with log_url. Setting log_url will automatically set target_url to the same value. Default: "" Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type. Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • state: "error" | "failure" | "inactive" | "in_progress" | "queued" | "pending" | "success"

    The state of the status. Can be one of error, failure, inactive, in_progress, queued pending, or success. Note: To use the inactive state, you must provide the application/vnd.github.ant-man-preview+json custom media type. To use the in_progress and queued states, you must provide the application/vnd.github.flash-preview+json custom media type.

  • Optional target_url?: string

    The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. Note: It's recommended to use the log_url parameter, which replaces target_url.

ReposCreateDeploymentStatusRequestOptions

ReposCreateDeploymentStatusRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ReposCreateDispatchEventEndpoint

ReposCreateDispatchEventEndpoint: { client_payload?: ReposCreateDispatchEventParamsClientPayload; event_type?: string; owner: string; repo: string }

Type declaration

  • Optional client_payload?: ReposCreateDispatchEventParamsClientPayload

    JSON payload with extra information about the webhook event that your action or worklow may use.

  • Optional event_type?: string

    Required: A custom webhook event name.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposCreateDispatchEventParamsClientPayload

ReposCreateDispatchEventParamsClientPayload: {}

Type declaration

ReposCreateDispatchEventRequestOptions

ReposCreateDispatchEventRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ReposCreateFileEndpoint

ReposCreateFileEndpoint: { author?: ReposCreateFileParamsAuthor; branch?: string; committer?: ReposCreateFileParamsCommitter; content: string; message: string; owner: string; path: string; repo: string; sha?: string }

Type declaration

  • Optional author?: ReposCreateFileParamsAuthor

    The author of the file. Default: The committer or the authenticated user if you omit committer.

  • Optional branch?: string

    The branch name. Default: the repository’s default branch (usually master)

  • Optional committer?: ReposCreateFileParamsCommitter

    The person that committed the file. Default: the authenticated user.

  • content: string

    The new file content, using Base64 encoding.

  • message: string

    The commit message.

  • owner: string

    owner parameter

  • path: string

    path parameter

  • repo: string

    repo parameter

  • Optional sha?: string

    Required if you are updating a file. The blob SHA of the file being replaced.

ReposCreateFileParamsAuthor

ReposCreateFileParamsAuthor: { email: string; name: string }

Type declaration

  • email: string
  • name: string

ReposCreateFileParamsCommitter

ReposCreateFileParamsCommitter: { email: string; name: string }

Type declaration

  • email: string
  • name: string

ReposCreateFileRequestOptions

ReposCreateFileRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

ReposCreateForAuthenticatedUserEndpoint

ReposCreateForAuthenticatedUserEndpoint: { allow_merge_commit?: boolean; allow_rebase_merge?: boolean; allow_squash_merge?: boolean; auto_init?: boolean; delete_branch_on_merge?: boolean; description?: string; gitignore_template?: string; has_issues?: boolean; has_projects?: boolean; has_wiki?: boolean; homepage?: string; is_template?: boolean; license_template?: string; name: string; private?: boolean; team_id?: number; visibility?: "public" | "private" | "visibility" | "internal" }

Type declaration

  • Optional allow_merge_commit?: boolean

    Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

  • Optional allow_rebase_merge?: boolean

    Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

  • Optional allow_squash_merge?: boolean

    Either true to allow squash-merging pull requests, or false to prevent squash-merging.

  • Optional auto_init?: boolean

    Pass true to create an initial commit with empty README.

  • Optional delete_branch_on_merge?: boolean

    Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

  • Optional description?: string

    A short description of the repository.

  • Optional gitignore_template?: string

    Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, "Haskell".

  • Optional has_issues?: boolean

    Either true to enable issues for this repository or false to disable them.

  • Optional has_projects?: boolean

    Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

  • Optional has_wiki?: boolean

    Either true to enable the wiki for this repository or false to disable it.

  • Optional homepage?: string

    A URL with more information about the repository.

  • Optional is_template?: boolean

    Either true to make this repo available as a template repository or false to prevent it.

  • Optional license_template?: string

    Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, "mit" or "mpl-2.0".

  • name: string

    The name of the repository.

  • Optional private?: boolean

    Either true to create a private repository or false to create a public one. Creating private repositories requires a paid GitHub account.

  • Optional team_id?: number

    The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

  • Optional visibility?: "public" | "private" | "visibility" | "internal"

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. For more information, see "Creating an internal repository" in the GitHub Help documentation. The visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.

ReposCreateForAuthenticatedUserRequestOptions

ReposCreateForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ReposCreateForkEndpoint

ReposCreateForkEndpoint: { organization?: string; owner: string; repo: string }

Type declaration

  • Optional organization?: string

    Optional parameter to specify the organization name if forking into an organization.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposCreateForkRequestOptions

ReposCreateForkRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ReposCreateHookEndpoint

ReposCreateHookEndpoint: { active?: boolean; config: ReposCreateHookParamsConfig; events?: string[]; name?: string; owner: string; repo: string }

Type declaration

  • Optional active?: boolean

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

  • config: ReposCreateHookParamsConfig

    Key/value pairs to provide settings for this webhook. These are defined below.

  • Optional events?: string[]

    Determines what events the hook is triggered for.

  • Optional name?: string

    Use web to create a webhook. Default: web. This parameter only accepts the value web.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposCreateHookParamsConfig

ReposCreateHookParamsConfig: { content_type?: string; insecure_ssl?: string; secret?: string; url: string }

Type declaration

  • Optional content_type?: string
  • Optional insecure_ssl?: string
  • Optional secret?: string
  • url: string

ReposCreateHookRequestOptions

ReposCreateHookRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ReposCreateInOrgEndpoint

ReposCreateInOrgEndpoint: { allow_merge_commit?: boolean; allow_rebase_merge?: boolean; allow_squash_merge?: boolean; auto_init?: boolean; delete_branch_on_merge?: boolean; description?: string; gitignore_template?: string; has_issues?: boolean; has_projects?: boolean; has_wiki?: boolean; homepage?: string; is_template?: boolean; license_template?: string; name: string; org: string; private?: boolean; team_id?: number; visibility?: "public" | "private" | "visibility" | "internal" }

Type declaration

  • Optional allow_merge_commit?: boolean

    Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

  • Optional allow_rebase_merge?: boolean

    Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

  • Optional allow_squash_merge?: boolean

    Either true to allow squash-merging pull requests, or false to prevent squash-merging.

  • Optional auto_init?: boolean

    Pass true to create an initial commit with empty README.

  • Optional delete_branch_on_merge?: boolean

    Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

  • Optional description?: string

    A short description of the repository.

  • Optional gitignore_template?: string

    Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, "Haskell".

  • Optional has_issues?: boolean

    Either true to enable issues for this repository or false to disable them.

  • Optional has_projects?: boolean

    Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

  • Optional has_wiki?: boolean

    Either true to enable the wiki for this repository or false to disable it.

  • Optional homepage?: string

    A URL with more information about the repository.

  • Optional is_template?: boolean

    Either true to make this repo available as a template repository or false to prevent it.

  • Optional license_template?: string

    Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, "mit" or "mpl-2.0".

  • name: string

    The name of the repository.

  • org: string

    org parameter

  • Optional private?: boolean

    Either true to create a private repository or false to create a public one. Creating private repositories requires a paid GitHub account.

  • Optional team_id?: number

    The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

  • Optional visibility?: "public" | "private" | "visibility" | "internal"

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. For more information, see "Creating an internal repository" in the GitHub Help documentation. The visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.

ReposCreateInOrgRequestOptions

ReposCreateInOrgRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ReposCreateOrUpdateFileEndpoint

ReposCreateOrUpdateFileEndpoint: { author?: ReposCreateOrUpdateFileParamsAuthor; branch?: string; committer?: ReposCreateOrUpdateFileParamsCommitter; content: string; message: string; owner: string; path: string; repo: string; sha?: string }

Type declaration

  • Optional author?: ReposCreateOrUpdateFileParamsAuthor

    The author of the file. Default: The committer or the authenticated user if you omit committer.

  • Optional branch?: string

    The branch name. Default: the repository’s default branch (usually master)

  • Optional committer?: ReposCreateOrUpdateFileParamsCommitter

    The person that committed the file. Default: the authenticated user.

  • content: string

    The new file content, using Base64 encoding.

  • message: string

    The commit message.

  • owner: string

    owner parameter

  • path: string

    path parameter

  • repo: string

    repo parameter

  • Optional sha?: string

    Required if you are updating a file. The blob SHA of the file being replaced.

ReposCreateOrUpdateFileParamsAuthor

ReposCreateOrUpdateFileParamsAuthor: { email: string; name: string }

Type declaration

  • email: string
  • name: string

ReposCreateOrUpdateFileParamsCommitter

ReposCreateOrUpdateFileParamsCommitter: { email: string; name: string }

Type declaration

  • email: string
  • name: string

ReposCreateOrUpdateFileRequestOptions

ReposCreateOrUpdateFileRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

ReposCreateReleaseEndpoint

ReposCreateReleaseEndpoint: { body?: string; draft?: boolean; name?: string; owner: string; prerelease?: boolean; repo: string; tag_name: string; target_commitish?: string }

Type declaration

  • Optional body?: string

    Text describing the contents of the tag.

  • Optional draft?: boolean

    true to create a draft (unpublished) release, false to create a published one.

  • Optional name?: string

    The name of the release.

  • owner: string

    owner parameter

  • Optional prerelease?: boolean

    true to identify the release as a prerelease. false to identify the release as a full release.

  • repo: string

    repo parameter

  • tag_name: string

    The name of the tag.

  • Optional target_commitish?: string

    Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

ReposCreateReleaseRequestOptions

ReposCreateReleaseRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ReposCreateStatusEndpoint

ReposCreateStatusEndpoint: { context?: string; description?: string; owner: string; repo: string; sha: string; state: "error" | "failure" | "pending" | "success"; target_url?: string }

Type declaration

  • Optional context?: string

    A string label to differentiate this status from the status of other systems.

  • Optional description?: string

    A short description of the status.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • sha: string

    sha parameter

  • state: "error" | "failure" | "pending" | "success"

    The state of the status. Can be one of error, failure, pending, or success.

  • Optional target_url?: string

    The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: http://ci.example.com/user/repo/build/sha

ReposCreateStatusRequestOptions

ReposCreateStatusRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ReposCreateUsingTemplateEndpoint

ReposCreateUsingTemplateEndpoint: { description?: string; name: string; owner?: string; private?: boolean; template_owner: string; template_repo: string }

Type declaration

  • Optional description?: string

    A short description of the new repository.

  • name: string

    The name of the new repository.

  • Optional owner?: string

    The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.

  • Optional private?: boolean

    Either true to create a new private repository or false to create a new public one.

  • template_owner: string

    template_owner parameter

  • template_repo: string

    template_repo parameter

ReposCreateUsingTemplateRequestOptions

ReposCreateUsingTemplateRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ReposDeclineInvitationEndpoint

ReposDeclineInvitationEndpoint: { invitation_id: number }

Type declaration

  • invitation_id: number

    invitation_id parameter

ReposDeclineInvitationRequestOptions

ReposDeclineInvitationRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ReposDeleteCommitCommentEndpoint

ReposDeleteCommitCommentEndpoint: { comment_id: number; owner: string; repo: string }

Type declaration

  • comment_id: number

    comment_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposDeleteCommitCommentRequestOptions

ReposDeleteCommitCommentRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ReposDeleteDeploymentEndpoint

ReposDeleteDeploymentEndpoint: { deployment_id: number; owner: string; repo: string }

Type declaration

  • deployment_id: number

    deployment_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposDeleteDeploymentRequestOptions

ReposDeleteDeploymentRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ReposDeleteDownloadEndpoint

ReposDeleteDownloadEndpoint: { download_id: number; owner: string; repo: string }

Type declaration

  • download_id: number

    download_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposDeleteDownloadRequestOptions

ReposDeleteDownloadRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ReposDeleteEndpoint

ReposDeleteEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposDeleteFileEndpoint

ReposDeleteFileEndpoint: { author?: ReposDeleteFileParamsAuthor; branch?: string; committer?: ReposDeleteFileParamsCommitter; message: string; owner: string; path: string; repo: string; sha: string }

Type declaration

  • Optional author?: ReposDeleteFileParamsAuthor

    object containing information about the author.

  • Optional branch?: string

    The branch name. Default: the repository’s default branch (usually master)

  • Optional committer?: ReposDeleteFileParamsCommitter

    object containing information about the committer.

  • message: string

    The commit message.

  • owner: string

    owner parameter

  • path: string

    path parameter

  • repo: string

    repo parameter

  • sha: string

    The blob SHA of the file being replaced.

ReposDeleteFileParamsAuthor

ReposDeleteFileParamsAuthor: { email?: string; name?: string }

Type declaration

  • Optional email?: string
  • Optional name?: string

ReposDeleteFileParamsCommitter

ReposDeleteFileParamsCommitter: { email?: string; name?: string }

Type declaration

  • Optional email?: string
  • Optional name?: string

ReposDeleteFileRequestOptions

ReposDeleteFileRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ReposDeleteHookEndpoint

ReposDeleteHookEndpoint: { hook_id: number; owner: string; repo: string }

Type declaration

  • hook_id: number

    hook_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposDeleteHookRequestOptions

ReposDeleteHookRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ReposDeleteInvitationEndpoint

ReposDeleteInvitationEndpoint: { invitation_id: number; owner: string; repo: string }

Type declaration

  • invitation_id: number

    invitation_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposDeleteInvitationRequestOptions

ReposDeleteInvitationRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ReposDeleteReleaseAssetEndpoint

ReposDeleteReleaseAssetEndpoint: { asset_id: number; owner: string; repo: string }

Type declaration

  • asset_id: number

    asset_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposDeleteReleaseAssetRequestOptions

ReposDeleteReleaseAssetRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ReposDeleteReleaseEndpoint

ReposDeleteReleaseEndpoint: { owner: string; release_id: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • release_id: number

    release_id parameter

  • repo: string

    repo parameter

ReposDeleteReleaseRequestOptions

ReposDeleteReleaseRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ReposDeleteRequestOptions

ReposDeleteRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ReposDisableAutomatedSecurityFixesEndpoint

ReposDisableAutomatedSecurityFixesEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposDisableAutomatedSecurityFixesRequestOptions

ReposDisableAutomatedSecurityFixesRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ReposDisablePagesSiteEndpoint

ReposDisablePagesSiteEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposDisablePagesSiteRequestOptions

ReposDisablePagesSiteRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ReposDisableVulnerabilityAlertsEndpoint

ReposDisableVulnerabilityAlertsEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposDisableVulnerabilityAlertsRequestOptions

ReposDisableVulnerabilityAlertsRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ReposEnableAutomatedSecurityFixesEndpoint

ReposEnableAutomatedSecurityFixesEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposEnableAutomatedSecurityFixesRequestOptions

ReposEnableAutomatedSecurityFixesRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

ReposEnablePagesSiteEndpoint

ReposEnablePagesSiteEndpoint: { owner: string; repo: string; source?: ReposEnablePagesSiteParamsSource }

Type declaration

ReposEnablePagesSiteParamsSource

ReposEnablePagesSiteParamsSource: { branch?: "master" | "gh-pages"; path?: string }

Type declaration

  • Optional branch?: "master" | "gh-pages"
  • Optional path?: string

ReposEnablePagesSiteRequestOptions

ReposEnablePagesSiteRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ReposEnableVulnerabilityAlertsEndpoint

ReposEnableVulnerabilityAlertsEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposEnableVulnerabilityAlertsRequestOptions

ReposEnableVulnerabilityAlertsRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

ReposGetAllTopicsEndpoint

ReposGetAllTopicsEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetAllTopicsRequestOptions

ReposGetAllTopicsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposGetAppsWithAccessToProtectedBranchEndpoint

ReposGetAppsWithAccessToProtectedBranchEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetAppsWithAccessToProtectedBranchRequestOptions

ReposGetAppsWithAccessToProtectedBranchRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposGetArchiveLinkEndpoint

ReposGetArchiveLinkEndpoint: { archive_format: string; owner: string; ref: string; repo: string }

Type declaration

  • archive_format: string

    archive_format parameter

  • owner: string

    owner parameter

  • ref: string

    ref parameter

  • repo: string

    repo parameter

ReposGetArchiveLinkRequestOptions

ReposGetArchiveLinkRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposGetBranchEndpoint

ReposGetBranchEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetBranchProtectionEndpoint

ReposGetBranchProtectionEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetBranchProtectionRequestOptions

ReposGetBranchProtectionRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposGetBranchRequestOptions

ReposGetBranchRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposGetClonesEndpoint

ReposGetClonesEndpoint: { owner: string; per?: "day" | "week"; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional per?: "day" | "week"

    Must be one of: day, week.

  • repo: string

    repo parameter

ReposGetClonesRequestOptions

ReposGetClonesRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposGetCodeFrequencyStatsEndpoint

ReposGetCodeFrequencyStatsEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetCodeFrequencyStatsRequestOptions

ReposGetCodeFrequencyStatsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposGetCollaboratorPermissionLevelEndpoint

ReposGetCollaboratorPermissionLevelEndpoint: { owner: string; repo: string; username: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • username: string

    username parameter

ReposGetCollaboratorPermissionLevelRequestOptions

ReposGetCollaboratorPermissionLevelRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposGetCombinedStatusForRefEndpoint

ReposGetCombinedStatusForRefEndpoint: { owner: string; ref: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • ref: string

    ref parameter

  • repo: string

    repo parameter

ReposGetCombinedStatusForRefRequestOptions

ReposGetCombinedStatusForRefRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposGetCommitActivityStatsEndpoint

ReposGetCommitActivityStatsEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetCommitActivityStatsRequestOptions

ReposGetCommitActivityStatsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposGetCommitCommentEndpoint

ReposGetCommitCommentEndpoint: { comment_id: number; owner: string; repo: string }

Type declaration

  • comment_id: number

    comment_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetCommitCommentRequestOptions

ReposGetCommitCommentRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposGetCommitEndpoint

ReposGetCommitEndpoint: { owner: string; ref: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • ref: string

    ref parameter

  • repo: string

    repo parameter

ReposGetCommitRequestOptions

ReposGetCommitRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposGetContentsEndpoint

ReposGetContentsEndpoint: { owner: string; path: string; ref?: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • path: string

    path parameter

  • Optional ref?: string

    The name of the commit/branch/tag. Default: the repository’s default branch (usually master)

  • repo: string

    repo parameter

ReposGetContentsRequestOptions

ReposGetContentsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposGetContributorsStatsEndpoint

ReposGetContributorsStatsEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetContributorsStatsRequestOptions

ReposGetContributorsStatsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposGetDeployKeyEndpoint

ReposGetDeployKeyEndpoint: { key_id: number; owner: string; repo: string }

Type declaration

  • key_id: number

    key_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetDeployKeyRequestOptions

ReposGetDeployKeyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposGetDeploymentEndpoint

ReposGetDeploymentEndpoint: { deployment_id: number; owner: string; repo: string }

Type declaration

  • deployment_id: number

    deployment_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetDeploymentRequestOptions

ReposGetDeploymentRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposGetDeploymentStatusEndpoint

ReposGetDeploymentStatusEndpoint: { deployment_id: number; owner: string; repo: string; status_id: number }

Type declaration

  • deployment_id: number

    deployment_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • status_id: number

    status_id parameter

ReposGetDeploymentStatusRequestOptions

ReposGetDeploymentStatusRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposGetDownloadEndpoint

ReposGetDownloadEndpoint: { download_id: number; owner: string; repo: string }

Type declaration

  • download_id: number

    download_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetDownloadRequestOptions

ReposGetDownloadRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposGetEndpoint

ReposGetEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetHookEndpoint

ReposGetHookEndpoint: { hook_id: number; owner: string; repo: string }

Type declaration

  • hook_id: number

    hook_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetHookRequestOptions

ReposGetHookRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposGetLatestPagesBuildEndpoint

ReposGetLatestPagesBuildEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetLatestPagesBuildRequestOptions

ReposGetLatestPagesBuildRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposGetLatestReleaseEndpoint

ReposGetLatestReleaseEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetLatestReleaseRequestOptions

ReposGetLatestReleaseRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposGetPagesBuildEndpoint

ReposGetPagesBuildEndpoint: { build_id: number; owner: string; repo: string }

Type declaration

  • build_id: number

    build_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetPagesBuildRequestOptions

ReposGetPagesBuildRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposGetPagesEndpoint

ReposGetPagesEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetPagesRequestOptions

ReposGetPagesRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposGetParticipationStatsEndpoint

ReposGetParticipationStatsEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetParticipationStatsRequestOptions

ReposGetParticipationStatsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposGetProtectedBranchAdminEnforcementEndpoint

ReposGetProtectedBranchAdminEnforcementEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetProtectedBranchAdminEnforcementRequestOptions

ReposGetProtectedBranchAdminEnforcementRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposGetProtectedBranchPullRequestReviewEnforcementEndpoint

ReposGetProtectedBranchPullRequestReviewEnforcementEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetProtectedBranchPullRequestReviewEnforcementRequestOptions

ReposGetProtectedBranchPullRequestReviewEnforcementRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposGetProtectedBranchRequiredSignaturesEndpoint

ReposGetProtectedBranchRequiredSignaturesEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetProtectedBranchRequiredSignaturesRequestOptions

ReposGetProtectedBranchRequiredSignaturesRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposGetProtectedBranchRequiredStatusChecksEndpoint

ReposGetProtectedBranchRequiredStatusChecksEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetProtectedBranchRequiredStatusChecksRequestOptions

ReposGetProtectedBranchRequiredStatusChecksRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposGetProtectedBranchRestrictionsEndpoint

ReposGetProtectedBranchRestrictionsEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetProtectedBranchRestrictionsRequestOptions

ReposGetProtectedBranchRestrictionsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposGetPunchCardStatsEndpoint

ReposGetPunchCardStatsEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetPunchCardStatsRequestOptions

ReposGetPunchCardStatsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposGetReadmeEndpoint

ReposGetReadmeEndpoint: { owner: string; ref?: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional ref?: string

    The name of the commit/branch/tag. Default: the repository’s default branch (usually master)

  • repo: string

    repo parameter

ReposGetReadmeRequestOptions

ReposGetReadmeRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposGetReleaseAssetEndpoint

ReposGetReleaseAssetEndpoint: { asset_id: number; owner: string; repo: string }

Type declaration

  • asset_id: number

    asset_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetReleaseAssetRequestOptions

ReposGetReleaseAssetRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposGetReleaseByTagEndpoint

ReposGetReleaseByTagEndpoint: { owner: string; repo: string; tag: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • tag: string

    tag parameter

ReposGetReleaseByTagRequestOptions

ReposGetReleaseByTagRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposGetReleaseEndpoint

ReposGetReleaseEndpoint: { owner: string; release_id: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • release_id: number

    release_id parameter

  • repo: string

    repo parameter

ReposGetReleaseRequestOptions

ReposGetReleaseRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposGetRequestOptions

ReposGetRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposGetTeamsWithAccessToProtectedBranchEndpoint

ReposGetTeamsWithAccessToProtectedBranchEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetTeamsWithAccessToProtectedBranchRequestOptions

ReposGetTeamsWithAccessToProtectedBranchRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposGetTopPathsEndpoint

ReposGetTopPathsEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetTopPathsRequestOptions

ReposGetTopPathsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposGetTopReferrersEndpoint

ReposGetTopReferrersEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetTopReferrersRequestOptions

ReposGetTopReferrersRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposGetUsersWithAccessToProtectedBranchEndpoint

ReposGetUsersWithAccessToProtectedBranchEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposGetUsersWithAccessToProtectedBranchRequestOptions

ReposGetUsersWithAccessToProtectedBranchRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposGetViewsEndpoint

ReposGetViewsEndpoint: { owner: string; per?: "day" | "week"; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional per?: "day" | "week"

    Must be one of: day, week.

  • repo: string

    repo parameter

ReposGetViewsRequestOptions

ReposGetViewsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposListAppsWithAccessToProtectedBranchEndpoint

ReposListAppsWithAccessToProtectedBranchEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposListAppsWithAccessToProtectedBranchRequestOptions

ReposListAppsWithAccessToProtectedBranchRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposListAssetsForReleaseEndpoint

ReposListAssetsForReleaseEndpoint: { owner: string; page?: number; per_page?: number; release_id: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • release_id: number

    release_id parameter

  • repo: string

    repo parameter

ReposListAssetsForReleaseRequestOptions

ReposListAssetsForReleaseRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposListBranchesEndpoint

ReposListBranchesEndpoint: { owner: string; page?: number; per_page?: number; protected?: boolean; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional protected?: boolean

    Setting to true returns only protected branches. When set to false, only unprotected branches are returned. Omitting this parameter returns all branches.

  • repo: string

    repo parameter

ReposListBranchesForHeadCommitEndpoint

ReposListBranchesForHeadCommitEndpoint: { commit_sha: string; owner: string; repo: string }

Type declaration

  • commit_sha: string

    commit_sha parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposListBranchesForHeadCommitRequestOptions

ReposListBranchesForHeadCommitRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposListBranchesRequestOptions

ReposListBranchesRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposListCollaboratorsEndpoint

ReposListCollaboratorsEndpoint: { affiliation?: "outside" | "direct" | "all"; owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • Optional affiliation?: "outside" | "direct" | "all"

    Filter collaborators returned by their affiliation. Can be one of: * outside: All outside collaborators of an organization-owned repository. * direct: All collaborators with permissions to an organization-owned repository, regardless of organization membership status. * all: All collaborators the authenticated user can see.

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ReposListCollaboratorsRequestOptions

ReposListCollaboratorsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposListCommentsForCommitEndpoint

ReposListCommentsForCommitEndpoint: { commit_sha: string; owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • commit_sha: string

    commit_sha parameter

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ReposListCommentsForCommitRequestOptions

ReposListCommentsForCommitRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposListCommitCommentsEndpoint

ReposListCommitCommentsEndpoint: { owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ReposListCommitCommentsRequestOptions

ReposListCommitCommentsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposListCommitsEndpoint

ReposListCommitsEndpoint: { author?: string; owner: string; page?: number; path?: string; per_page?: number; repo: string; sha?: string; since?: string; until?: string }

Type declaration

  • Optional author?: string

    GitHub login or email address by which to filter by commit author.

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional path?: string

    Only commits containing this file path will be returned.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

  • Optional sha?: string

    SHA or branch to start listing commits from. Default: the repository’s default branch (usually master).

  • Optional since?: string

    Only commits after this date will be returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

  • Optional until?: string

    Only commits before this date will be returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

ReposListCommitsRequestOptions

ReposListCommitsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposListContributorsEndpoint

ReposListContributorsEndpoint: { anon?: string; owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • Optional anon?: string

    Set to 1 or true to include anonymous contributors in results.

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ReposListContributorsRequestOptions

ReposListContributorsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposListDeployKeysEndpoint

ReposListDeployKeysEndpoint: { owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ReposListDeployKeysRequestOptions

ReposListDeployKeysRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposListDeploymentStatusesEndpoint

ReposListDeploymentStatusesEndpoint: { deployment_id: number; owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • deployment_id: number

    deployment_id parameter

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ReposListDeploymentStatusesRequestOptions

ReposListDeploymentStatusesRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposListDeploymentsEndpoint

ReposListDeploymentsEndpoint: { environment?: string; owner: string; page?: number; per_page?: number; ref?: string; repo: string; sha?: string; task?: string }

Type declaration

  • Optional environment?: string

    The name of the environment that was deployed to (e.g., staging or production).

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional ref?: string

    The name of the ref. This can be a branch, tag, or SHA.

  • repo: string

    repo parameter

  • Optional sha?: string

    The SHA recorded at creation time.

  • Optional task?: string

    The name of the task for the deployment (e.g., deploy or deploy:migrations).

ReposListDeploymentsRequestOptions

ReposListDeploymentsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposListDownloadsEndpoint

ReposListDownloadsEndpoint: { owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ReposListDownloadsRequestOptions

ReposListDownloadsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposListEndpoint

ReposListEndpoint: { affiliation?: string; direction?: "asc" | "desc"; page?: number; per_page?: number; sort?: "created" | "updated" | "pushed" | "full_name"; type?: "all" | "owner" | "public" | "private" | "member"; visibility?: "all" | "public" | "private" }

Type declaration

  • Optional affiliation?: string

    Comma-separated list of values. Can include: * owner: Repositories that are owned by the authenticated user. * collaborator: Repositories that the user has been added to as a collaborator. * organization_member: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.

  • Optional direction?: "asc" | "desc"

    Can be one of asc or desc. Default: asc when using full_name, otherwise desc

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional sort?: "created" | "updated" | "pushed" | "full_name"

    Can be one of created, updated, pushed, full_name.

  • Optional type?: "all" | "owner" | "public" | "private" | "member"

    Can be one of all, owner, public, private, member. Default: all

    Will cause a 422 error if used in the same request as visibility or affiliation. Will cause a 422 error if used in the same request as visibility or affiliation.

  • Optional visibility?: "all" | "public" | "private"

    Can be one of all, public, or private.

ReposListForAuthenticatedUserEndpoint

ReposListForAuthenticatedUserEndpoint: { affiliation?: string; direction?: "asc" | "desc"; page?: number; per_page?: number; sort?: "created" | "updated" | "pushed" | "full_name"; type?: "all" | "owner" | "public" | "private" | "member"; visibility?: "all" | "public" | "private" }

Type declaration

  • Optional affiliation?: string

    Comma-separated list of values. Can include: * owner: Repositories that are owned by the authenticated user. * collaborator: Repositories that the user has been added to as a collaborator. * organization_member: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.

  • Optional direction?: "asc" | "desc"

    Can be one of asc or desc. Default: asc when using full_name, otherwise desc

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional sort?: "created" | "updated" | "pushed" | "full_name"

    Can be one of created, updated, pushed, full_name.

  • Optional type?: "all" | "owner" | "public" | "private" | "member"

    Can be one of all, owner, public, private, member. Default: all

    Will cause a 422 error if used in the same request as visibility or affiliation. Will cause a 422 error if used in the same request as visibility or affiliation.

  • Optional visibility?: "all" | "public" | "private"

    Can be one of all, public, or private.

ReposListForAuthenticatedUserRequestOptions

ReposListForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposListForOrgEndpoint

ReposListForOrgEndpoint: { direction?: "asc" | "desc"; org: string; page?: number; per_page?: number; sort?: "created" | "updated" | "pushed" | "full_name"; type?: "all" | "public" | "private" | "forks" | "sources" | "member" | "internal" }

Type declaration

  • Optional direction?: "asc" | "desc"

    Can be one of asc or desc. Default: when using full_name: asc, otherwise desc

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional sort?: "created" | "updated" | "pushed" | "full_name"

    Can be one of created, updated, pushed, full_name.

  • Optional type?: "all" | "public" | "private" | "forks" | "sources" | "member" | "internal"

    Specifies the types of repositories you want returned. Can be one of all, public, private, forks, sources, member, internal. Default: all. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, type can also be internal.

ReposListForOrgRequestOptions

ReposListForOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposListForUserEndpoint

ReposListForUserEndpoint: { direction?: "asc" | "desc"; page?: number; per_page?: number; sort?: "created" | "updated" | "pushed" | "full_name"; type?: "all" | "owner" | "member"; username: string }

Type declaration

  • Optional direction?: "asc" | "desc"

    Can be one of asc or desc. Default: asc when using full_name, otherwise desc

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional sort?: "created" | "updated" | "pushed" | "full_name"

    Can be one of created, updated, pushed, full_name.

  • Optional type?: "all" | "owner" | "member"

    Can be one of all, owner, member.

  • username: string

    username parameter

ReposListForUserRequestOptions

ReposListForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposListForksEndpoint

ReposListForksEndpoint: { owner: string; page?: number; per_page?: number; repo: string; sort?: "newest" | "oldest" | "stargazers" }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

  • Optional sort?: "newest" | "oldest" | "stargazers"

    The sort order. Can be either newest, oldest, or stargazers.

ReposListForksRequestOptions

ReposListForksRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposListHooksEndpoint

ReposListHooksEndpoint: { owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ReposListHooksRequestOptions

ReposListHooksRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposListInvitationsEndpoint

ReposListInvitationsEndpoint: { owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ReposListInvitationsForAuthenticatedUserEndpoint

ReposListInvitationsForAuthenticatedUserEndpoint: { page?: number; per_page?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

ReposListInvitationsForAuthenticatedUserRequestOptions

ReposListInvitationsForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposListInvitationsRequestOptions

ReposListInvitationsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposListLanguagesEndpoint

ReposListLanguagesEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposListLanguagesRequestOptions

ReposListLanguagesRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposListPagesBuildsEndpoint

ReposListPagesBuildsEndpoint: { owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ReposListPagesBuildsRequestOptions

ReposListPagesBuildsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposListProtectedBranchRequiredStatusChecksContextsEndpoint

ReposListProtectedBranchRequiredStatusChecksContextsEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposListProtectedBranchRequiredStatusChecksContextsRequestOptions

ReposListProtectedBranchRequiredStatusChecksContextsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposListProtectedBranchTeamRestrictionsEndpoint

ReposListProtectedBranchTeamRestrictionsEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposListProtectedBranchTeamRestrictionsRequestOptions

ReposListProtectedBranchTeamRestrictionsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposListProtectedBranchUserRestrictionsEndpoint

ReposListProtectedBranchUserRestrictionsEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposListProtectedBranchUserRestrictionsRequestOptions

ReposListProtectedBranchUserRestrictionsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposListPublicEndpoint

ReposListPublicEndpoint: { page?: number; per_page?: number; since?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional since?: number

    The integer ID of the last repository that you've seen.

ReposListPublicRequestOptions

ReposListPublicRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposListPullRequestsAssociatedWithCommitEndpoint

ReposListPullRequestsAssociatedWithCommitEndpoint: { commit_sha: string; owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • commit_sha: string

    commit_sha parameter

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ReposListPullRequestsAssociatedWithCommitRequestOptions

ReposListPullRequestsAssociatedWithCommitRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposListReleasesEndpoint

ReposListReleasesEndpoint: { owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ReposListReleasesRequestOptions

ReposListReleasesRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposListRequestOptions

ReposListRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposListStatusesForRefEndpoint

ReposListStatusesForRefEndpoint: { owner: string; page?: number; per_page?: number; ref: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • ref: string

    ref parameter

  • repo: string

    repo parameter

ReposListStatusesForRefRequestOptions

ReposListStatusesForRefRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposListTagsEndpoint

ReposListTagsEndpoint: { owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ReposListTagsRequestOptions

ReposListTagsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposListTeamsEndpoint

ReposListTeamsEndpoint: { owner: string; page?: number; per_page?: number; repo: string }

Type declaration

  • owner: string

    owner parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • repo: string

    repo parameter

ReposListTeamsRequestOptions

ReposListTeamsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposListTeamsWithAccessToProtectedBranchEndpoint

ReposListTeamsWithAccessToProtectedBranchEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposListTeamsWithAccessToProtectedBranchRequestOptions

ReposListTeamsWithAccessToProtectedBranchRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposListTopicsEndpoint

ReposListTopicsEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposListTopicsRequestOptions

ReposListTopicsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposListUsersWithAccessToProtectedBranchEndpoint

ReposListUsersWithAccessToProtectedBranchEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposListUsersWithAccessToProtectedBranchRequestOptions

ReposListUsersWithAccessToProtectedBranchRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposMergeEndpoint

ReposMergeEndpoint: { base: string; commit_message?: string; head: string; owner: string; repo: string }

Type declaration

  • base: string

    The name of the base branch that the head will be merged into.

  • Optional commit_message?: string

    Commit message to use for the merge commit. If omitted, a default message will be used.

  • head: string

    The head to merge. This can be a branch name or a commit SHA1.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposMergeRequestOptions

ReposMergeRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ReposPingHookEndpoint

ReposPingHookEndpoint: { hook_id: number; owner: string; repo: string }

Type declaration

  • hook_id: number

    hook_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposPingHookRequestOptions

ReposPingHookRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ReposRemoveBranchProtectionEndpoint

ReposRemoveBranchProtectionEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposRemoveBranchProtectionRequestOptions

ReposRemoveBranchProtectionRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ReposRemoveCollaboratorEndpoint

ReposRemoveCollaboratorEndpoint: { owner: string; repo: string; username: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • username: string

    username parameter

ReposRemoveCollaboratorRequestOptions

ReposRemoveCollaboratorRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ReposRemoveDeployKeyEndpoint

ReposRemoveDeployKeyEndpoint: { key_id: number; owner: string; repo: string }

Type declaration

  • key_id: number

    key_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposRemoveDeployKeyRequestOptions

ReposRemoveDeployKeyRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ReposRemoveProtectedBranchAdminEnforcementEndpoint

ReposRemoveProtectedBranchAdminEnforcementEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposRemoveProtectedBranchAdminEnforcementRequestOptions

ReposRemoveProtectedBranchAdminEnforcementRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ReposRemoveProtectedBranchAppRestrictionsEndpoint

ReposRemoveProtectedBranchAppRestrictionsEndpoint: { apps: string[]; branch: string; owner: string; repo: string }

Type declaration

  • apps: string[]

    apps parameter

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposRemoveProtectedBranchAppRestrictionsRequestOptions

ReposRemoveProtectedBranchAppRestrictionsRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ReposRemoveProtectedBranchPullRequestReviewEnforcementEndpoint

ReposRemoveProtectedBranchPullRequestReviewEnforcementEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposRemoveProtectedBranchPullRequestReviewEnforcementRequestOptions

ReposRemoveProtectedBranchPullRequestReviewEnforcementRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ReposRemoveProtectedBranchRequiredSignaturesEndpoint

ReposRemoveProtectedBranchRequiredSignaturesEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposRemoveProtectedBranchRequiredSignaturesRequestOptions

ReposRemoveProtectedBranchRequiredSignaturesRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ReposRemoveProtectedBranchRequiredStatusChecksContextsEndpoint

ReposRemoveProtectedBranchRequiredStatusChecksContextsEndpoint: { branch: string; contexts: string[]; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • contexts: string[]

    contexts parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposRemoveProtectedBranchRequiredStatusChecksContextsRequestOptions

ReposRemoveProtectedBranchRequiredStatusChecksContextsRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ReposRemoveProtectedBranchRequiredStatusChecksEndpoint

ReposRemoveProtectedBranchRequiredStatusChecksEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposRemoveProtectedBranchRequiredStatusChecksRequestOptions

ReposRemoveProtectedBranchRequiredStatusChecksRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ReposRemoveProtectedBranchRestrictionsEndpoint

ReposRemoveProtectedBranchRestrictionsEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposRemoveProtectedBranchRestrictionsRequestOptions

ReposRemoveProtectedBranchRestrictionsRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ReposRemoveProtectedBranchTeamRestrictionsEndpoint

ReposRemoveProtectedBranchTeamRestrictionsEndpoint: { branch: string; owner: string; repo: string; teams: string[] }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • teams: string[]

    teams parameter

ReposRemoveProtectedBranchTeamRestrictionsRequestOptions

ReposRemoveProtectedBranchTeamRestrictionsRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ReposRemoveProtectedBranchUserRestrictionsEndpoint

ReposRemoveProtectedBranchUserRestrictionsEndpoint: { branch: string; owner: string; repo: string; users: string[] }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • users: string[]

    users parameter

ReposRemoveProtectedBranchUserRestrictionsRequestOptions

ReposRemoveProtectedBranchUserRestrictionsRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ReposReplaceAllTopicsEndpoint

ReposReplaceAllTopicsEndpoint: { names: string[]; owner: string; repo: string }

Type declaration

  • names: string[]

    An array of topics to add to the repository. Pass one or more topics to replace the set of existing topics. Send an empty array ([]) to clear all topics from the repository. Note: Topic names cannot contain uppercase letters.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposReplaceAllTopicsRequestOptions

ReposReplaceAllTopicsRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

ReposReplaceProtectedBranchAppRestrictionsEndpoint

ReposReplaceProtectedBranchAppRestrictionsEndpoint: { apps: string[]; branch: string; owner: string; repo: string }

Type declaration

  • apps: string[]

    apps parameter

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposReplaceProtectedBranchAppRestrictionsRequestOptions

ReposReplaceProtectedBranchAppRestrictionsRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

ReposReplaceProtectedBranchRequiredStatusChecksContextsEndpoint

ReposReplaceProtectedBranchRequiredStatusChecksContextsEndpoint: { branch: string; contexts: string[]; owner: string; repo: string }

Type declaration

  • branch: string

    branch parameter

  • contexts: string[]

    contexts parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposReplaceProtectedBranchRequiredStatusChecksContextsRequestOptions

ReposReplaceProtectedBranchRequiredStatusChecksContextsRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

ReposReplaceProtectedBranchTeamRestrictionsEndpoint

ReposReplaceProtectedBranchTeamRestrictionsEndpoint: { branch: string; owner: string; repo: string; teams: string[] }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • teams: string[]

    teams parameter

ReposReplaceProtectedBranchTeamRestrictionsRequestOptions

ReposReplaceProtectedBranchTeamRestrictionsRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

ReposReplaceProtectedBranchUserRestrictionsEndpoint

ReposReplaceProtectedBranchUserRestrictionsEndpoint: { branch: string; owner: string; repo: string; users: string[] }

Type declaration

  • branch: string

    branch parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • users: string[]

    users parameter

ReposReplaceProtectedBranchUserRestrictionsRequestOptions

ReposReplaceProtectedBranchUserRestrictionsRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

ReposReplaceTopicsEndpoint

ReposReplaceTopicsEndpoint: { names: string[]; owner: string; repo: string }

Type declaration

  • names: string[]

    An array of topics to add to the repository. Pass one or more topics to replace the set of existing topics. Send an empty array ([]) to clear all topics from the repository. Note: Topic names cannot contain uppercase letters.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposReplaceTopicsRequestOptions

ReposReplaceTopicsRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

ReposRequestPageBuildEndpoint

ReposRequestPageBuildEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposRequestPageBuildRequestOptions

ReposRequestPageBuildRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ReposRetrieveCommunityProfileMetricsEndpoint

ReposRetrieveCommunityProfileMetricsEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposRetrieveCommunityProfileMetricsRequestOptions

ReposRetrieveCommunityProfileMetricsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ReposTestPushHookEndpoint

ReposTestPushHookEndpoint: { hook_id: number; owner: string; repo: string }

Type declaration

  • hook_id: number

    hook_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposTestPushHookRequestOptions

ReposTestPushHookRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ReposTransferEndpoint

ReposTransferEndpoint: { new_owner?: string; owner: string; repo: string; team_ids?: number[] }

Type declaration

  • Optional new_owner?: string

    Required: The username or organization name the repository will be transferred to.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • Optional team_ids?: number[]

    ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.

ReposTransferRequestOptions

ReposTransferRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ReposUpdateBranchProtectionEndpoint

ReposUpdateBranchProtectionEndpoint: { allow_deletions?: boolean; allow_force_pushes?: boolean | null; branch: string; enforce_admins: boolean | null; owner: string; repo: string; required_linear_history?: boolean; required_pull_request_reviews: ReposUpdateBranchProtectionParamsRequiredPullRequestReviews | null; required_status_checks: ReposUpdateBranchProtectionParamsRequiredStatusChecks | null; restrictions: ReposUpdateBranchProtectionParamsRestrictions | null }

Type declaration

  • Optional allow_deletions?: boolean

    Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see "Enabling force pushes to a protected branch" in the GitHub Help documentation.

  • Optional allow_force_pushes?: boolean | null

    Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see "Enabling force pushes to a protected branch" in the GitHub Help documentation."

  • branch: string

    branch parameter

  • enforce_admins: boolean | null

    Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • Optional required_linear_history?: boolean

    Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see "Requiring a linear commit history" in the GitHub Help documentation.

  • required_pull_request_reviews: ReposUpdateBranchProtectionParamsRequiredPullRequestReviews | null

    Require at least one approving review on a pull request, before merging. Set to null to disable.

  • required_status_checks: ReposUpdateBranchProtectionParamsRequiredStatusChecks | null

    Require status checks to pass before merging. Set to null to disable.

  • restrictions: ReposUpdateBranchProtectionParamsRestrictions | null

    Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

ReposUpdateBranchProtectionParamsRequiredPullRequestReviews

ReposUpdateBranchProtectionParamsRequiredPullRequestReviews: { dismiss_stale_reviews?: boolean; dismissal_restrictions?: ReposUpdateBranchProtectionParamsRequiredPullRequestReviewsDismissalRestrictions; require_code_owner_reviews?: boolean; required_approving_review_count?: number }

Type declaration

ReposUpdateBranchProtectionParamsRequiredPullRequestReviewsDismissalRestrictions

ReposUpdateBranchProtectionParamsRequiredPullRequestReviewsDismissalRestrictions: { teams?: string[]; users?: string[] }

Type declaration

  • Optional teams?: string[]
  • Optional users?: string[]

ReposUpdateBranchProtectionParamsRequiredStatusChecks

ReposUpdateBranchProtectionParamsRequiredStatusChecks: { contexts: string[]; strict: boolean }

Type declaration

  • contexts: string[]
  • strict: boolean

ReposUpdateBranchProtectionParamsRestrictions

ReposUpdateBranchProtectionParamsRestrictions: { apps?: string[]; teams: string[]; users: string[] }

Type declaration

  • Optional apps?: string[]
  • teams: string[]
  • users: string[]

ReposUpdateBranchProtectionRequestOptions

ReposUpdateBranchProtectionRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

ReposUpdateCommitCommentEndpoint

ReposUpdateCommitCommentEndpoint: { body: string; comment_id: number; owner: string; repo: string }

Type declaration

  • body: string

    The contents of the comment

  • comment_id: number

    comment_id parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposUpdateCommitCommentRequestOptions

ReposUpdateCommitCommentRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

ReposUpdateEndpoint

ReposUpdateEndpoint: { allow_merge_commit?: boolean; allow_rebase_merge?: boolean; allow_squash_merge?: boolean; archived?: boolean; default_branch?: string; delete_branch_on_merge?: boolean; description?: string; has_issues?: boolean; has_projects?: boolean; has_wiki?: boolean; homepage?: string; is_template?: boolean; name?: string; owner: string; private?: boolean; repo: string; visibility?: "public" | "private" | "visibility" | "internal" }

Type declaration

  • Optional allow_merge_commit?: boolean

    Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

  • Optional allow_rebase_merge?: boolean

    Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

  • Optional allow_squash_merge?: boolean

    Either true to allow squash-merging pull requests, or false to prevent squash-merging.

  • Optional archived?: boolean

    true to archive this repository. Note: You cannot unarchive repositories through the API.

  • Optional default_branch?: string

    Updates the default branch for this repository.

  • Optional delete_branch_on_merge?: boolean

    Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

  • Optional description?: string

    A short description of the repository.

  • Optional has_issues?: boolean

    Either true to enable issues for this repository or false to disable them.

  • Optional has_projects?: boolean

    Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

  • Optional has_wiki?: boolean

    Either true to enable the wiki for this repository or false to disable it.

  • Optional homepage?: string

    A URL with more information about the repository.

  • Optional is_template?: boolean

    Either true to make this repo available as a template repository or false to prevent it.

  • Optional name?: string

    The name of the repository.

  • owner: string

    owner parameter

  • Optional private?: boolean

    Either true to make the repository private or false to make it public. Creating private repositories requires a paid GitHub account. Default: false. Note: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private. Note: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.

  • repo: string

    repo parameter

  • Optional visibility?: "public" | "private" | "visibility" | "internal"

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. The visibility parameter overrides the private parameter when you use both along with the nebula-preview preview header.

ReposUpdateFileEndpoint

ReposUpdateFileEndpoint: { author?: ReposUpdateFileParamsAuthor; branch?: string; committer?: ReposUpdateFileParamsCommitter; content: string; message: string; owner: string; path: string; repo: string; sha?: string }

Type declaration

  • Optional author?: ReposUpdateFileParamsAuthor

    The author of the file. Default: The committer or the authenticated user if you omit committer.

  • Optional branch?: string

    The branch name. Default: the repository’s default branch (usually master)

  • Optional committer?: ReposUpdateFileParamsCommitter

    The person that committed the file. Default: the authenticated user.

  • content: string

    The new file content, using Base64 encoding.

  • message: string

    The commit message.

  • owner: string

    owner parameter

  • path: string

    path parameter

  • repo: string

    repo parameter

  • Optional sha?: string

    Required if you are updating a file. The blob SHA of the file being replaced.

ReposUpdateFileParamsAuthor

ReposUpdateFileParamsAuthor: { email: string; name: string }

Type declaration

  • email: string
  • name: string

ReposUpdateFileParamsCommitter

ReposUpdateFileParamsCommitter: { email: string; name: string }

Type declaration

  • email: string
  • name: string

ReposUpdateFileRequestOptions

ReposUpdateFileRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

ReposUpdateHookEndpoint

ReposUpdateHookEndpoint: { active?: boolean; add_events?: string[]; config?: ReposUpdateHookParamsConfig; events?: string[]; hook_id: number; owner: string; remove_events?: string[]; repo: string }

Type declaration

  • Optional active?: boolean

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

  • Optional add_events?: string[]

    Determines a list of events to be added to the list of events that the Hook triggers for.

  • Optional config?: ReposUpdateHookParamsConfig

    Key/value pairs to provide settings for this webhook. These are defined below.

  • Optional events?: string[]

    Determines what events the hook is triggered for. This replaces the entire array of events.

  • hook_id: number

    hook_id parameter

  • owner: string

    owner parameter

  • Optional remove_events?: string[]

    Determines a list of events to be removed from the list of events that the Hook triggers for.

  • repo: string

    repo parameter

ReposUpdateHookParamsConfig

ReposUpdateHookParamsConfig: { content_type?: string; insecure_ssl?: string; secret?: string; url: string }

Type declaration

  • Optional content_type?: string
  • Optional insecure_ssl?: string
  • Optional secret?: string
  • url: string

ReposUpdateHookRequestOptions

ReposUpdateHookRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

ReposUpdateInformationAboutPagesSiteEndpoint

ReposUpdateInformationAboutPagesSiteEndpoint: { cname?: string; owner: string; repo: string; source?: ""gh-pages"" | ""master"" | ""master /docs"" }

Type declaration

  • Optional cname?: string

    Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see "Using a custom domain with GitHub Pages."

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • Optional source?: ""gh-pages"" | ""master"" | ""master /docs""

    Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory /docs. Possible values are "gh-pages", "master", and "master /docs".

ReposUpdateInformationAboutPagesSiteRequestOptions

ReposUpdateInformationAboutPagesSiteRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

ReposUpdateInvitationEndpoint

ReposUpdateInvitationEndpoint: { invitation_id: number; owner: string; permissions?: "read" | "write" | "admin"; repo: string }

Type declaration

  • invitation_id: number

    invitation_id parameter

  • owner: string

    owner parameter

  • Optional permissions?: "read" | "write" | "admin"

    The permissions that the associated user will have on the repository. Valid values are read, write, and admin.

  • repo: string

    repo parameter

ReposUpdateInvitationRequestOptions

ReposUpdateInvitationRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

ReposUpdateProtectedBranchPullRequestReviewEnforcementEndpoint

ReposUpdateProtectedBranchPullRequestReviewEnforcementEndpoint: { branch: string; dismiss_stale_reviews?: boolean; dismissal_restrictions?: ReposUpdateProtectedBranchPullRequestReviewEnforcementParamsDismissalRestrictions; owner: string; repo: string; require_code_owner_reviews?: boolean; required_approving_review_count?: number }

Type declaration

  • branch: string

    branch parameter

  • Optional dismiss_stale_reviews?: boolean

    Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

  • Optional dismissal_restrictions?: ReposUpdateProtectedBranchPullRequestReviewEnforcementParamsDismissalRestrictions

    Specify which users and teams can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • Optional require_code_owner_reviews?: boolean

    Blocks merging pull requests until code owners have reviewed.

  • Optional required_approving_review_count?: number

    Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6.

ReposUpdateProtectedBranchPullRequestReviewEnforcementParamsDismissalRestrictions

ReposUpdateProtectedBranchPullRequestReviewEnforcementParamsDismissalRestrictions: { teams?: string[]; users?: string[] }

Type declaration

  • Optional teams?: string[]
  • Optional users?: string[]

ReposUpdateProtectedBranchPullRequestReviewEnforcementRequestOptions

ReposUpdateProtectedBranchPullRequestReviewEnforcementRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

ReposUpdateProtectedBranchRequiredStatusChecksEndpoint

ReposUpdateProtectedBranchRequiredStatusChecksEndpoint: { branch: string; contexts?: string[]; owner: string; repo: string; strict?: boolean }

Type declaration

  • branch: string

    branch parameter

  • Optional contexts?: string[]

    The list of status checks to require in order to merge into this branch

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • Optional strict?: boolean

    Require branches to be up to date before merging.

ReposUpdateProtectedBranchRequiredStatusChecksRequestOptions

ReposUpdateProtectedBranchRequiredStatusChecksRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

ReposUpdateReleaseAssetEndpoint

ReposUpdateReleaseAssetEndpoint: { asset_id: number; label?: string; name?: string; owner: string; repo: string }

Type declaration

  • asset_id: number

    asset_id parameter

  • Optional label?: string

    An alternate short description of the asset. Used in place of the filename.

  • Optional name?: string

    The file name of the asset.

  • owner: string

    owner parameter

  • repo: string

    repo parameter

ReposUpdateReleaseAssetRequestOptions

ReposUpdateReleaseAssetRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

ReposUpdateReleaseEndpoint

ReposUpdateReleaseEndpoint: { body?: string; draft?: boolean; name?: string; owner: string; prerelease?: boolean; release_id: number; repo: string; tag_name?: string; target_commitish?: string }

Type declaration

  • Optional body?: string

    Text describing the contents of the tag.

  • Optional draft?: boolean

    true makes the release a draft, and false publishes the release.

  • Optional name?: string

    The name of the release.

  • owner: string

    owner parameter

  • Optional prerelease?: boolean

    true to identify the release as a prerelease, false to identify the release as a full release.

  • release_id: number

    release_id parameter

  • repo: string

    repo parameter

  • Optional tag_name?: string

    The name of the tag.

  • Optional target_commitish?: string

    Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

ReposUpdateReleaseRequestOptions

ReposUpdateReleaseRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

ReposUpdateRequestOptions

ReposUpdateRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

ReposUploadReleaseAssetEndpoint

ReposUploadReleaseAssetEndpoint: { data: string; label?: string; name?: string; origin?: string; owner: string; release_id: number; repo: string }

Type declaration

  • data: string

    The raw file data

  • Optional label?: string

    label parameter

  • Optional name?: string

    name parameter

  • Optional origin?: string

    The URL origin (protocol + host name + port) is included in upload_url returned in the response of the "Create a release" endpoint

  • owner: string

    owner parameter

  • release_id: number

    release_id parameter

  • repo: string

    repo parameter

ReposUploadReleaseAssetRequestOptions

ReposUploadReleaseAssetRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ScimGetProvisioningDetailsForUserEndpoint

ScimGetProvisioningDetailsForUserEndpoint: { org: string; scim_user_id: number }

Type declaration

  • org: string

    org parameter

  • scim_user_id: number

    scim_user_id parameter

ScimGetProvisioningDetailsForUserRequestOptions

ScimGetProvisioningDetailsForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ScimListProvisionedIdentitiesEndpoint

ScimListProvisionedIdentitiesEndpoint: { count?: number; filter?: string; org: string; startIndex?: number }

Type declaration

  • Optional count?: number

    Used for pagination: the number of results to return.

  • Optional filter?: string

    Filters results using the equals query parameter operator (eq). You can filter results that are equal to id, userName, emails, and external_id. For example, to search for an identity with the userName Octocat, you would use this query: ?filter=userName%20eq%20\"Octocat\".

  • org: string

    org parameter

  • Optional startIndex?: number

    Used for pagination: the index of the first result to return.

ScimListProvisionedIdentitiesRequestOptions

ScimListProvisionedIdentitiesRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

ScimProvisionAndInviteUsersEndpoint

ScimProvisionAndInviteUsersEndpoint: { org: string }

Type declaration

  • org: string

    org parameter

ScimProvisionAndInviteUsersRequestOptions

ScimProvisionAndInviteUsersRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ScimProvisionInviteUsersEndpoint

ScimProvisionInviteUsersEndpoint: { org: string }

Type declaration

  • org: string

    org parameter

ScimProvisionInviteUsersRequestOptions

ScimProvisionInviteUsersRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

ScimRemoveUserFromOrgEndpoint

ScimRemoveUserFromOrgEndpoint: { org: string; scim_user_id: number }

Type declaration

  • org: string

    org parameter

  • scim_user_id: number

    scim_user_id parameter

ScimRemoveUserFromOrgRequestOptions

ScimRemoveUserFromOrgRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

ScimReplaceProvisionedUserInformationEndpoint

ScimReplaceProvisionedUserInformationEndpoint: { org: string; scim_user_id: number }

Type declaration

  • org: string

    org parameter

  • scim_user_id: number

    scim_user_id parameter

ScimReplaceProvisionedUserInformationRequestOptions

ScimReplaceProvisionedUserInformationRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

ScimUpdateProvisionedOrgMembershipEndpoint

ScimUpdateProvisionedOrgMembershipEndpoint: { org: string; scim_user_id: number }

Type declaration

  • org: string

    org parameter

  • scim_user_id: number

    scim_user_id parameter

ScimUpdateProvisionedOrgMembershipRequestOptions

ScimUpdateProvisionedOrgMembershipRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

ScimUpdateUserAttributeEndpoint

ScimUpdateUserAttributeEndpoint: { org: string; scim_user_id: number }

Type declaration

  • org: string

    org parameter

  • scim_user_id: number

    scim_user_id parameter

ScimUpdateUserAttributeRequestOptions

ScimUpdateUserAttributeRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

SearchCodeEndpoint

SearchCodeEndpoint: { order?: "desc" | "asc"; page?: number; per_page?: number; q: string; sort?: "indexed" }

Type declaration

  • Optional order?: "desc" | "asc"

    Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • q: string

    The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see Constructing a search query. See "Searching code" for a detailed list of qualifiers.

  • Optional sort?: "indexed"

    Sorts the results of your query. Can only be indexed, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: best match

SearchCodeRequestOptions

SearchCodeRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

SearchCommitsEndpoint

SearchCommitsEndpoint: { order?: "desc" | "asc"; page?: number; per_page?: number; q: string; sort?: "author-date" | "committer-date" }

Type declaration

  • Optional order?: "desc" | "asc"

    Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • q: string

    The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see Constructing a search query. See "Searching commits" for a detailed list of qualifiers.

  • Optional sort?: "author-date" | "committer-date"

    Sorts the results of your query by author-date or committer-date. Default: best match

SearchCommitsRequestOptions

SearchCommitsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

SearchEmailLegacyEndpoint

SearchEmailLegacyEndpoint: { email: string }

Type declaration

  • email: string

    The email address.

SearchEmailLegacyRequestOptions

SearchEmailLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

SearchIssuesAndPullRequestsEndpoint

SearchIssuesAndPullRequestsEndpoint: { order?: "desc" | "asc"; page?: number; per_page?: number; q: string; sort?: "comments" | "reactions" | "reactions-+1" | "reactions--1" | "reactions-smile" | "reactions-thinking_face" | "reactions-heart" | "reactions-tada" | "interactions" | "created" | "updated" }

Type declaration

  • Optional order?: "desc" | "asc"

    Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • q: string

    The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see Constructing a search query. See "Searching issues and pull requests" for a detailed list of qualifiers.

  • Optional sort?: "comments" | "reactions" | "reactions-+1" | "reactions--1" | "reactions-smile" | "reactions-thinking_face" | "reactions-heart" | "reactions-tada" | "interactions" | "created" | "updated"

    Sorts the results of your query by the number of comments, reactions, reactions-+1, reactions--1, reactions-smile, reactions-thinking_face, reactions-heart, reactions-tada, or interactions. You can also sort results by how recently the items were created or updated, Default: best match

SearchIssuesAndPullRequestsRequestOptions

SearchIssuesAndPullRequestsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

SearchIssuesEndpoint

SearchIssuesEndpoint: { order?: "desc" | "asc"; page?: number; per_page?: number; q: string; sort?: "comments" | "reactions" | "reactions-+1" | "reactions--1" | "reactions-smile" | "reactions-thinking_face" | "reactions-heart" | "reactions-tada" | "interactions" | "created" | "updated" }

Type declaration

  • Optional order?: "desc" | "asc"

    Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • q: string

    The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see Constructing a search query. See "Searching issues and pull requests" for a detailed list of qualifiers.

  • Optional sort?: "comments" | "reactions" | "reactions-+1" | "reactions--1" | "reactions-smile" | "reactions-thinking_face" | "reactions-heart" | "reactions-tada" | "interactions" | "created" | "updated"

    Sorts the results of your query by the number of comments, reactions, reactions-+1, reactions--1, reactions-smile, reactions-thinking_face, reactions-heart, reactions-tada, or interactions. You can also sort results by how recently the items were created or updated, Default: best match

SearchIssuesLegacyEndpoint

SearchIssuesLegacyEndpoint: { keyword: string; owner: string; repository: string; state: "open" | "closed" }

Type declaration

  • keyword: string

    The search term.

  • owner: string

    owner parameter

  • repository: string

    repository parameter

  • state: "open" | "closed"

    Indicates the state of the issues to return. Can be either open or closed.

SearchIssuesLegacyRequestOptions

SearchIssuesLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

SearchIssuesRequestOptions

SearchIssuesRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

SearchLabelsEndpoint

SearchLabelsEndpoint: { order?: "desc" | "asc"; q: string; repository_id: number; sort?: "created" | "updated" }

Type declaration

  • Optional order?: "desc" | "asc"

    Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.

  • q: string

    The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see Constructing a search query.

  • repository_id: number

    The id of the repository.

  • Optional sort?: "created" | "updated"

    Sorts the results of your query by when the label was created or updated. Default: best match

SearchLabelsRequestOptions

SearchLabelsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

SearchReposEndpoint

SearchReposEndpoint: { order?: "desc" | "asc"; page?: number; per_page?: number; q: string; sort?: "stars" | "forks" | "help-wanted-issues" | "updated" }

Type declaration

  • Optional order?: "desc" | "asc"

    Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • q: string

    The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see Constructing a search query. See "Searching for repositories" for a detailed list of qualifiers.

  • Optional sort?: "stars" | "forks" | "help-wanted-issues" | "updated"

    Sorts the results of your query by number of stars, forks, or help-wanted-issues or how recently the items were updated. Default: best match

SearchReposLegacyEndpoint

SearchReposLegacyEndpoint: { keyword: string; language?: string; order?: "asc" | "desc"; sort?: "stars" | "forks" | "updated"; start_page?: string }

Type declaration

  • keyword: string

    The search term.

  • Optional language?: string

    Filter results by language.

  • Optional order?: "asc" | "desc"

    The sort field. if sort param is provided. Can be either asc or desc.

  • Optional sort?: "stars" | "forks" | "updated"

    The sort field. One of stars, forks, or updated. Default: results are sorted by best match.

  • Optional start_page?: string

    The page number to fetch.

SearchReposLegacyRequestOptions

SearchReposLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

SearchReposRequestOptions

SearchReposRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

SearchTopicsEndpoint

SearchTopicsEndpoint: { q: string }

Type declaration

  • q: string

    The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see Constructing a search query.

SearchTopicsRequestOptions

SearchTopicsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

SearchUsersEndpoint

SearchUsersEndpoint: { order?: "desc" | "asc"; page?: number; per_page?: number; q: string; sort?: "followers" | "repositories" | "joined" }

Type declaration

  • Optional order?: "desc" | "asc"

    Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • q: string

    The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see Constructing a search query. See "Searching users" for a detailed list of qualifiers.

  • Optional sort?: "followers" | "repositories" | "joined"

    Sorts the results of your query by number of followers or repositories, or when the person joined GitHub. Default: best match

SearchUsersLegacyEndpoint

SearchUsersLegacyEndpoint: { keyword: string; order?: "asc" | "desc"; sort?: "stars" | "forks" | "updated"; start_page?: string }

Type declaration

  • keyword: string

    The search term.

  • Optional order?: "asc" | "desc"

    The sort field. if sort param is provided. Can be either asc or desc.

  • Optional sort?: "stars" | "forks" | "updated"

    The sort field. One of stars, forks, or updated. Default: results are sorted by best match.

  • Optional start_page?: string

    The page number to fetch.

SearchUsersLegacyRequestOptions

SearchUsersLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

SearchUsersRequestOptions

SearchUsersRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsAddMemberEndpoint

TeamsAddMemberEndpoint: { team_id: number; username: string }

Type declaration

  • team_id: number

    team_id parameter

  • username: string

    username parameter

TeamsAddMemberLegacyEndpoint

TeamsAddMemberLegacyEndpoint: { team_id: number; username: string }

Type declaration

  • team_id: number

    team_id parameter

  • username: string

    username parameter

TeamsAddMemberLegacyRequestOptions

TeamsAddMemberLegacyRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsAddMemberRequestOptions

TeamsAddMemberRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsAddOrUpdateMembershipEndpoint

TeamsAddOrUpdateMembershipEndpoint: { role?: "member" | "maintainer"; team_id: number; username: string }

Type declaration

  • Optional role?: "member" | "maintainer"

    The role that this user should have in the team. Can be one of: * member - a normal member of the team. * maintainer - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description.

  • team_id: number

    team_id parameter

  • username: string

    username parameter

TeamsAddOrUpdateMembershipInOrgEndpoint

TeamsAddOrUpdateMembershipInOrgEndpoint: { org: string; role?: "member" | "maintainer"; team_slug: string; username: string }

Type declaration

  • org: string

    org parameter

  • Optional role?: "member" | "maintainer"

    The role that this user should have in the team. Can be one of: * member - a normal member of the team. * maintainer - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description.

  • team_slug: string

    team_slug parameter

  • username: string

    username parameter

TeamsAddOrUpdateMembershipInOrgRequestOptions

TeamsAddOrUpdateMembershipInOrgRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsAddOrUpdateMembershipLegacyEndpoint

TeamsAddOrUpdateMembershipLegacyEndpoint: { role?: "member" | "maintainer"; team_id: number; username: string }

Type declaration

  • Optional role?: "member" | "maintainer"

    The role that this user should have in the team. Can be one of: * member - a normal member of the team. * maintainer - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description.

  • team_id: number

    team_id parameter

  • username: string

    username parameter

TeamsAddOrUpdateMembershipLegacyRequestOptions

TeamsAddOrUpdateMembershipLegacyRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsAddOrUpdateMembershipRequestOptions

TeamsAddOrUpdateMembershipRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsAddOrUpdateProjectEndpoint

TeamsAddOrUpdateProjectEndpoint: { permission?: "read" | "write" | "admin"; project_id: number; team_id: number }

Type declaration

  • Optional permission?: "read" | "write" | "admin"

    The permission to grant to the team for this project. Can be one of: * read - team members can read, but not write to or administer this project. * write - team members can read and write, but not administer this project. * admin - team members can read, write and administer this project. Default: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."

  • project_id: number

    project_id parameter

  • team_id: number

    team_id parameter

TeamsAddOrUpdateProjectInOrgEndpoint

TeamsAddOrUpdateProjectInOrgEndpoint: { org: string; permission?: "read" | "write" | "admin"; project_id: number; team_slug: string }

Type declaration

  • org: string

    org parameter

  • Optional permission?: "read" | "write" | "admin"

    The permission to grant to the team for this project. Can be one of: * read - team members can read, but not write to or administer this project. * write - team members can read and write, but not administer this project. * admin - team members can read, write and administer this project. Default: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."

  • project_id: number

    project_id parameter

  • team_slug: string

    team_slug parameter

TeamsAddOrUpdateProjectInOrgRequestOptions

TeamsAddOrUpdateProjectInOrgRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsAddOrUpdateProjectLegacyEndpoint

TeamsAddOrUpdateProjectLegacyEndpoint: { permission?: "read" | "write" | "admin"; project_id: number; team_id: number }

Type declaration

  • Optional permission?: "read" | "write" | "admin"

    The permission to grant to the team for this project. Can be one of: * read - team members can read, but not write to or administer this project. * write - team members can read and write, but not administer this project. * admin - team members can read, write and administer this project. Default: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."

  • project_id: number

    project_id parameter

  • team_id: number

    team_id parameter

TeamsAddOrUpdateProjectLegacyRequestOptions

TeamsAddOrUpdateProjectLegacyRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsAddOrUpdateProjectRequestOptions

TeamsAddOrUpdateProjectRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsAddOrUpdateRepoEndpoint

TeamsAddOrUpdateRepoEndpoint: { owner: string; permission?: "pull" | "push" | "admin"; repo: string; team_id: number }

Type declaration

  • owner: string

    owner parameter

  • Optional permission?: "pull" | "push" | "admin"

    The permission to grant the team on this repository. Can be one of: * pull - team members can pull, but not push to or administer this repository. * push - team members can pull and push, but not administer this repository. * admin - team members can pull, push and administer this repository.

    If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.

  • repo: string

    repo parameter

  • team_id: number

    team_id parameter

TeamsAddOrUpdateRepoInOrgEndpoint

TeamsAddOrUpdateRepoInOrgEndpoint: { org: string; owner: string; permission?: "pull" | "push" | "admin"; repo: string; team_slug: string }

Type declaration

  • org: string

    org parameter

  • owner: string

    owner parameter

  • Optional permission?: "pull" | "push" | "admin"

    The permission to grant the team on this repository. Can be one of: * pull - team members can pull, but not push to or administer this repository. * push - team members can pull and push, but not administer this repository. * admin - team members can pull, push and administer this repository.

    If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.

  • repo: string

    repo parameter

  • team_slug: string

    team_slug parameter

TeamsAddOrUpdateRepoInOrgRequestOptions

TeamsAddOrUpdateRepoInOrgRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsAddOrUpdateRepoLegacyEndpoint

TeamsAddOrUpdateRepoLegacyEndpoint: { owner: string; permission?: "pull" | "push" | "admin"; repo: string; team_id: number }

Type declaration

  • owner: string

    owner parameter

  • Optional permission?: "pull" | "push" | "admin"

    The permission to grant the team on this repository. Can be one of: * pull - team members can pull, but not push to or administer this repository. * push - team members can pull and push, but not administer this repository. * admin - team members can pull, push and administer this repository.

    If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.

  • repo: string

    repo parameter

  • team_id: number

    team_id parameter

TeamsAddOrUpdateRepoLegacyRequestOptions

TeamsAddOrUpdateRepoLegacyRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsAddOrUpdateRepoRequestOptions

TeamsAddOrUpdateRepoRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsCheckManagesRepoEndpoint

TeamsCheckManagesRepoEndpoint: { owner: string; repo: string; team_id: number }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • team_id: number

    team_id parameter

TeamsCheckManagesRepoInOrgEndpoint

TeamsCheckManagesRepoInOrgEndpoint: { org: string; owner: string; repo: string; team_slug: string }

Type declaration

  • org: string

    org parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • team_slug: string

    team_slug parameter

TeamsCheckManagesRepoInOrgRequestOptions

TeamsCheckManagesRepoInOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsCheckManagesRepoLegacyEndpoint

TeamsCheckManagesRepoLegacyEndpoint: { owner: string; repo: string; team_id: number }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • team_id: number

    team_id parameter

TeamsCheckManagesRepoLegacyRequestOptions

TeamsCheckManagesRepoLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsCheckManagesRepoRequestOptions

TeamsCheckManagesRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsCreateDiscussionCommentEndpoint

TeamsCreateDiscussionCommentEndpoint: { body: string; discussion_number: number; team_id: number }

Type declaration

  • body: string

    The discussion comment's body text.

  • discussion_number: number

    discussion_number parameter

  • team_id: number

    team_id parameter

TeamsCreateDiscussionCommentInOrgEndpoint

TeamsCreateDiscussionCommentInOrgEndpoint: { body: string; discussion_number: number; org: string; team_slug: string }

Type declaration

  • body: string

    The discussion comment's body text.

  • discussion_number: number

    discussion_number parameter

  • org: string

    org parameter

  • team_slug: string

    team_slug parameter

TeamsCreateDiscussionCommentInOrgRequestOptions

TeamsCreateDiscussionCommentInOrgRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsCreateDiscussionCommentLegacyEndpoint

TeamsCreateDiscussionCommentLegacyEndpoint: { body: string; discussion_number: number; team_id: number }

Type declaration

  • body: string

    The discussion comment's body text.

  • discussion_number: number

    discussion_number parameter

  • team_id: number

    team_id parameter

TeamsCreateDiscussionCommentLegacyRequestOptions

TeamsCreateDiscussionCommentLegacyRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsCreateDiscussionCommentRequestOptions

TeamsCreateDiscussionCommentRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsCreateDiscussionEndpoint

TeamsCreateDiscussionEndpoint: { body: string; private?: boolean; team_id: number; title: string }

Type declaration

  • body: string

    The discussion post's body text.

  • Optional private?: boolean

    Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.

  • team_id: number

    team_id parameter

  • title: string

    The discussion post's title.

TeamsCreateDiscussionInOrgEndpoint

TeamsCreateDiscussionInOrgEndpoint: { body: string; org: string; private?: boolean; team_slug: string; title: string }

Type declaration

  • body: string

    The discussion post's body text.

  • org: string

    org parameter

  • Optional private?: boolean

    Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.

  • team_slug: string

    team_slug parameter

  • title: string

    The discussion post's title.

TeamsCreateDiscussionInOrgRequestOptions

TeamsCreateDiscussionInOrgRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsCreateDiscussionLegacyEndpoint

TeamsCreateDiscussionLegacyEndpoint: { body: string; private?: boolean; team_id: number; title: string }

Type declaration

  • body: string

    The discussion post's body text.

  • Optional private?: boolean

    Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.

  • team_id: number

    team_id parameter

  • title: string

    The discussion post's title.

TeamsCreateDiscussionLegacyRequestOptions

TeamsCreateDiscussionLegacyRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsCreateDiscussionRequestOptions

TeamsCreateDiscussionRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsCreateEndpoint

TeamsCreateEndpoint: { description?: string; maintainers?: string[]; name: string; org: string; parent_team_id?: number; permission?: "pull" | "push" | "admin"; privacy?: "secret" | "closed"; repo_names?: string[] }

Type declaration

  • Optional description?: string

    The description of the team.

  • Optional maintainers?: string[]

    List GitHub IDs for organization members who will become team maintainers.

  • name: string

    The name of the team.

  • org: string

    org parameter

  • Optional parent_team_id?: number

    The ID of a team to set as the parent team.

  • Optional permission?: "pull" | "push" | "admin"

    Deprecated. The permission that new repositories will be added to the team with when none is specified. Can be one of: * pull - team members can pull, but not push to or administer newly-added repositories. * push - team members can pull and push, but not administer newly-added repositories. * admin - team members can pull, push and administer newly-added repositories.

  • Optional privacy?: "secret" | "closed"

    The level of privacy this team should have. The options are: For a non-nested team: * secret - only visible to organization owners and members of this team. * closed - visible to all members of this organization. Default: secret For a parent or child team: * closed - visible to all members of this organization. Default for child team: closed

  • Optional repo_names?: string[]

    The full name (e.g., "organization-name/repository-name") of repositories to add the team to.

TeamsCreateOrUpdateIdPGroupConnectionsEndpoint

TeamsCreateOrUpdateIdPGroupConnectionsEndpoint: { groups: TeamsCreateOrUpdateIdPGroupConnectionsParamsGroups[]; team_id: number }

Type declaration

  • groups: TeamsCreateOrUpdateIdPGroupConnectionsParamsGroups[]

    The IdP groups you want to connect to a GitHub team. When updating, the new groups object will replace the original one. You must include any existing groups that you don't want to remove.

  • team_id: number

    team_id parameter

TeamsCreateOrUpdateIdPGroupConnectionsInOrgEndpoint

TeamsCreateOrUpdateIdPGroupConnectionsInOrgEndpoint: { groups: TeamsCreateOrUpdateIdPGroupConnectionsInOrgParamsGroups[]; org: string; team_slug: string }

Type declaration

  • groups: TeamsCreateOrUpdateIdPGroupConnectionsInOrgParamsGroups[]

    The IdP groups you want to connect to a GitHub team. When updating, the new groups object will replace the original one. You must include any existing groups that you don't want to remove.

  • org: string

    org parameter

  • team_slug: string

    team_slug parameter

TeamsCreateOrUpdateIdPGroupConnectionsInOrgParamsGroups

TeamsCreateOrUpdateIdPGroupConnectionsInOrgParamsGroups: { group_description: string; group_id: string; group_name: string }

Type declaration

  • group_description: string
  • group_id: string
  • group_name: string

TeamsCreateOrUpdateIdPGroupConnectionsInOrgRequestOptions

TeamsCreateOrUpdateIdPGroupConnectionsInOrgRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsCreateOrUpdateIdPGroupConnectionsLegacyEndpoint

TeamsCreateOrUpdateIdPGroupConnectionsLegacyEndpoint: { groups: TeamsCreateOrUpdateIdPGroupConnectionsLegacyParamsGroups[]; team_id: number }

Type declaration

  • groups: TeamsCreateOrUpdateIdPGroupConnectionsLegacyParamsGroups[]

    The IdP groups you want to connect to a GitHub team. When updating, the new groups object will replace the original one. You must include any existing groups that you don't want to remove.

  • team_id: number

    team_id parameter

TeamsCreateOrUpdateIdPGroupConnectionsLegacyParamsGroups

TeamsCreateOrUpdateIdPGroupConnectionsLegacyParamsGroups: { group_description: string; group_id: string; group_name: string }

Type declaration

  • group_description: string
  • group_id: string
  • group_name: string

TeamsCreateOrUpdateIdPGroupConnectionsLegacyRequestOptions

TeamsCreateOrUpdateIdPGroupConnectionsLegacyRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsCreateOrUpdateIdPGroupConnectionsParamsGroups

TeamsCreateOrUpdateIdPGroupConnectionsParamsGroups: { group_description: string; group_id: string; group_name: string }

Type declaration

  • group_description: string
  • group_id: string
  • group_name: string

TeamsCreateOrUpdateIdPGroupConnectionsRequestOptions

TeamsCreateOrUpdateIdPGroupConnectionsRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsCreateRequestOptions

TeamsCreateRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsDeleteDiscussionCommentEndpoint

TeamsDeleteDiscussionCommentEndpoint: { comment_number: number; discussion_number: number; team_id: number }

Type declaration

  • comment_number: number

    comment_number parameter

  • discussion_number: number

    discussion_number parameter

  • team_id: number

    team_id parameter

TeamsDeleteDiscussionCommentInOrgEndpoint

TeamsDeleteDiscussionCommentInOrgEndpoint: { comment_number: number; discussion_number: number; org: string; team_slug: string }

Type declaration

  • comment_number: number

    comment_number parameter

  • discussion_number: number

    discussion_number parameter

  • org: string

    org parameter

  • team_slug: string

    team_slug parameter

TeamsDeleteDiscussionCommentInOrgRequestOptions

TeamsDeleteDiscussionCommentInOrgRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsDeleteDiscussionCommentLegacyEndpoint

TeamsDeleteDiscussionCommentLegacyEndpoint: { comment_number: number; discussion_number: number; team_id: number }

Type declaration

  • comment_number: number

    comment_number parameter

  • discussion_number: number

    discussion_number parameter

  • team_id: number

    team_id parameter

TeamsDeleteDiscussionCommentLegacyRequestOptions

TeamsDeleteDiscussionCommentLegacyRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsDeleteDiscussionCommentRequestOptions

TeamsDeleteDiscussionCommentRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsDeleteDiscussionEndpoint

TeamsDeleteDiscussionEndpoint: { discussion_number: number; team_id: number }

Type declaration

  • discussion_number: number

    discussion_number parameter

  • team_id: number

    team_id parameter

TeamsDeleteDiscussionInOrgEndpoint

TeamsDeleteDiscussionInOrgEndpoint: { discussion_number: number; org: string; team_slug: string }

Type declaration

  • discussion_number: number

    discussion_number parameter

  • org: string

    org parameter

  • team_slug: string

    team_slug parameter

TeamsDeleteDiscussionInOrgRequestOptions

TeamsDeleteDiscussionInOrgRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsDeleteDiscussionLegacyEndpoint

TeamsDeleteDiscussionLegacyEndpoint: { discussion_number: number; team_id: number }

Type declaration

  • discussion_number: number

    discussion_number parameter

  • team_id: number

    team_id parameter

TeamsDeleteDiscussionLegacyRequestOptions

TeamsDeleteDiscussionLegacyRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsDeleteDiscussionRequestOptions

TeamsDeleteDiscussionRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsDeleteEndpoint

TeamsDeleteEndpoint: { team_id: number }

Type declaration

  • team_id: number

    team_id parameter

TeamsDeleteInOrgEndpoint

TeamsDeleteInOrgEndpoint: { org: string; team_slug: string }

Type declaration

  • org: string

    org parameter

  • team_slug: string

    team_slug parameter

TeamsDeleteInOrgRequestOptions

TeamsDeleteInOrgRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsDeleteLegacyEndpoint

TeamsDeleteLegacyEndpoint: { team_id: number }

Type declaration

  • team_id: number

    team_id parameter

TeamsDeleteLegacyRequestOptions

TeamsDeleteLegacyRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsDeleteRequestOptions

TeamsDeleteRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsGetByNameEndpoint

TeamsGetByNameEndpoint: { org: string; team_slug: string }

Type declaration

  • org: string

    org parameter

  • team_slug: string

    team_slug parameter

TeamsGetByNameRequestOptions

TeamsGetByNameRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsGetDiscussionCommentEndpoint

TeamsGetDiscussionCommentEndpoint: { comment_number: number; discussion_number: number; team_id: number }

Type declaration

  • comment_number: number

    comment_number parameter

  • discussion_number: number

    discussion_number parameter

  • team_id: number

    team_id parameter

TeamsGetDiscussionCommentInOrgEndpoint

TeamsGetDiscussionCommentInOrgEndpoint: { comment_number: number; discussion_number: number; org: string; team_slug: string }

Type declaration

  • comment_number: number

    comment_number parameter

  • discussion_number: number

    discussion_number parameter

  • org: string

    org parameter

  • team_slug: string

    team_slug parameter

TeamsGetDiscussionCommentInOrgRequestOptions

TeamsGetDiscussionCommentInOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsGetDiscussionCommentLegacyEndpoint

TeamsGetDiscussionCommentLegacyEndpoint: { comment_number: number; discussion_number: number; team_id: number }

Type declaration

  • comment_number: number

    comment_number parameter

  • discussion_number: number

    discussion_number parameter

  • team_id: number

    team_id parameter

TeamsGetDiscussionCommentLegacyRequestOptions

TeamsGetDiscussionCommentLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsGetDiscussionCommentRequestOptions

TeamsGetDiscussionCommentRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsGetDiscussionEndpoint

TeamsGetDiscussionEndpoint: { discussion_number: number; team_id: number }

Type declaration

  • discussion_number: number

    discussion_number parameter

  • team_id: number

    team_id parameter

TeamsGetDiscussionInOrgEndpoint

TeamsGetDiscussionInOrgEndpoint: { discussion_number: number; org: string; team_slug: string }

Type declaration

  • discussion_number: number

    discussion_number parameter

  • org: string

    org parameter

  • team_slug: string

    team_slug parameter

TeamsGetDiscussionInOrgRequestOptions

TeamsGetDiscussionInOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsGetDiscussionLegacyEndpoint

TeamsGetDiscussionLegacyEndpoint: { discussion_number: number; team_id: number }

Type declaration

  • discussion_number: number

    discussion_number parameter

  • team_id: number

    team_id parameter

TeamsGetDiscussionLegacyRequestOptions

TeamsGetDiscussionLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsGetDiscussionRequestOptions

TeamsGetDiscussionRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsGetEndpoint

TeamsGetEndpoint: { team_id: number }

Type declaration

  • team_id: number

    team_id parameter

TeamsGetLegacyEndpoint

TeamsGetLegacyEndpoint: { team_id: number }

Type declaration

  • team_id: number

    team_id parameter

TeamsGetLegacyRequestOptions

TeamsGetLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsGetMemberEndpoint

TeamsGetMemberEndpoint: { team_id: number; username: string }

Type declaration

  • team_id: number

    team_id parameter

  • username: string

    username parameter

TeamsGetMemberLegacyEndpoint

TeamsGetMemberLegacyEndpoint: { team_id: number; username: string }

Type declaration

  • team_id: number

    team_id parameter

  • username: string

    username parameter

TeamsGetMemberLegacyRequestOptions

TeamsGetMemberLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsGetMemberRequestOptions

TeamsGetMemberRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsGetMembershipEndpoint

TeamsGetMembershipEndpoint: { team_id: number; username: string }

Type declaration

  • team_id: number

    team_id parameter

  • username: string

    username parameter

TeamsGetMembershipInOrgEndpoint

TeamsGetMembershipInOrgEndpoint: { org: string; team_slug: string; username: string }

Type declaration

  • org: string

    org parameter

  • team_slug: string

    team_slug parameter

  • username: string

    username parameter

TeamsGetMembershipInOrgRequestOptions

TeamsGetMembershipInOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsGetMembershipLegacyEndpoint

TeamsGetMembershipLegacyEndpoint: { team_id: number; username: string }

Type declaration

  • team_id: number

    team_id parameter

  • username: string

    username parameter

TeamsGetMembershipLegacyRequestOptions

TeamsGetMembershipLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsGetMembershipRequestOptions

TeamsGetMembershipRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsGetRequestOptions

TeamsGetRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsListChildEndpoint

TeamsListChildEndpoint: { page?: number; per_page?: number; team_id: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • team_id: number

    team_id parameter

TeamsListChildInOrgEndpoint

TeamsListChildInOrgEndpoint: { org: string; page?: number; per_page?: number; team_slug: string }

Type declaration

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • team_slug: string

    team_slug parameter

TeamsListChildInOrgRequestOptions

TeamsListChildInOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsListChildLegacyEndpoint

TeamsListChildLegacyEndpoint: { page?: number; per_page?: number; team_id: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • team_id: number

    team_id parameter

TeamsListChildLegacyRequestOptions

TeamsListChildLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsListChildRequestOptions

TeamsListChildRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsListDiscussionCommentsEndpoint

TeamsListDiscussionCommentsEndpoint: { direction?: "asc" | "desc"; discussion_number: number; page?: number; per_page?: number; team_id: number }

Type declaration

  • Optional direction?: "asc" | "desc"

    Sorts the discussion comments by the date they were created. To return the oldest comments first, set to asc. Can be one of asc or desc.

  • discussion_number: number

    discussion_number parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • team_id: number

    team_id parameter

TeamsListDiscussionCommentsInOrgEndpoint

TeamsListDiscussionCommentsInOrgEndpoint: { direction?: "asc" | "desc"; discussion_number: number; org: string; page?: number; per_page?: number; team_slug: string }

Type declaration

  • Optional direction?: "asc" | "desc"

    Sorts the discussion comments by the date they were created. To return the oldest comments first, set to asc. Can be one of asc or desc.

  • discussion_number: number

    discussion_number parameter

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • team_slug: string

    team_slug parameter

TeamsListDiscussionCommentsInOrgRequestOptions

TeamsListDiscussionCommentsInOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsListDiscussionCommentsLegacyEndpoint

TeamsListDiscussionCommentsLegacyEndpoint: { direction?: "asc" | "desc"; discussion_number: number; page?: number; per_page?: number; team_id: number }

Type declaration

  • Optional direction?: "asc" | "desc"

    Sorts the discussion comments by the date they were created. To return the oldest comments first, set to asc. Can be one of asc or desc.

  • discussion_number: number

    discussion_number parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • team_id: number

    team_id parameter

TeamsListDiscussionCommentsLegacyRequestOptions

TeamsListDiscussionCommentsLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsListDiscussionCommentsRequestOptions

TeamsListDiscussionCommentsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsListDiscussionsEndpoint

TeamsListDiscussionsEndpoint: { direction?: "asc" | "desc"; page?: number; per_page?: number; team_id: number }

Type declaration

  • Optional direction?: "asc" | "desc"

    Sorts the discussion comments by the date they were created. To return the oldest comments first, set to asc. Can be one of asc or desc.

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • team_id: number

    team_id parameter

TeamsListDiscussionsInOrgEndpoint

TeamsListDiscussionsInOrgEndpoint: { direction?: "asc" | "desc"; org: string; page?: number; per_page?: number; team_slug: string }

Type declaration

  • Optional direction?: "asc" | "desc"

    Sorts the discussion comments by the date they were created. To return the oldest comments first, set to asc. Can be one of asc or desc.

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • team_slug: string

    team_slug parameter

TeamsListDiscussionsInOrgRequestOptions

TeamsListDiscussionsInOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsListDiscussionsLegacyEndpoint

TeamsListDiscussionsLegacyEndpoint: { direction?: "asc" | "desc"; page?: number; per_page?: number; team_id: number }

Type declaration

  • Optional direction?: "asc" | "desc"

    Sorts the discussion comments by the date they were created. To return the oldest comments first, set to asc. Can be one of asc or desc.

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • team_id: number

    team_id parameter

TeamsListDiscussionsLegacyRequestOptions

TeamsListDiscussionsLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsListDiscussionsRequestOptions

TeamsListDiscussionsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsListEndpoint

TeamsListEndpoint: { org: string; page?: number; per_page?: number }

Type declaration

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

TeamsListForAuthenticatedUserEndpoint

TeamsListForAuthenticatedUserEndpoint: { page?: number; per_page?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

TeamsListForAuthenticatedUserRequestOptions

TeamsListForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsListIdPGroupsForEndpoint

TeamsListIdPGroupsForEndpoint: { team_id: number }

Type declaration

  • team_id: number

    team_id parameter

TeamsListIdPGroupsForLegacyEndpoint

TeamsListIdPGroupsForLegacyEndpoint: { team_id: number }

Type declaration

  • team_id: number

    team_id parameter

TeamsListIdPGroupsForLegacyRequestOptions

TeamsListIdPGroupsForLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsListIdPGroupsForOrgEndpoint

TeamsListIdPGroupsForOrgEndpoint: { org: string; page?: number; per_page?: number }

Type declaration

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

TeamsListIdPGroupsForOrgRequestOptions

TeamsListIdPGroupsForOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsListIdPGroupsForRequestOptions

TeamsListIdPGroupsForRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsListIdPGroupsInOrgEndpoint

TeamsListIdPGroupsInOrgEndpoint: { org: string; team_slug: string }

Type declaration

  • org: string

    org parameter

  • team_slug: string

    team_slug parameter

TeamsListIdPGroupsInOrgRequestOptions

TeamsListIdPGroupsInOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsListMembersEndpoint

TeamsListMembersEndpoint: { page?: number; per_page?: number; role?: "member" | "maintainer" | "all"; team_id: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional role?: "member" | "maintainer" | "all"

    Filters members returned by their role in the team. Can be one of: * member - normal members of the team. * maintainer - team maintainers. * all - all members of the team.

  • team_id: number

    team_id parameter

TeamsListMembersInOrgEndpoint

TeamsListMembersInOrgEndpoint: { org: string; page?: number; per_page?: number; role?: "member" | "maintainer" | "all"; team_slug: string }

Type declaration

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional role?: "member" | "maintainer" | "all"

    Filters members returned by their role in the team. Can be one of: * member - normal members of the team. * maintainer - team maintainers. * all - all members of the team.

  • team_slug: string

    team_slug parameter

TeamsListMembersInOrgRequestOptions

TeamsListMembersInOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsListMembersLegacyEndpoint

TeamsListMembersLegacyEndpoint: { page?: number; per_page?: number; role?: "member" | "maintainer" | "all"; team_id: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional role?: "member" | "maintainer" | "all"

    Filters members returned by their role in the team. Can be one of: * member - normal members of the team. * maintainer - team maintainers. * all - all members of the team.

  • team_id: number

    team_id parameter

TeamsListMembersLegacyRequestOptions

TeamsListMembersLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsListMembersRequestOptions

TeamsListMembersRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsListPendingInvitationsEndpoint

TeamsListPendingInvitationsEndpoint: { page?: number; per_page?: number; team_id: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • team_id: number

    team_id parameter

TeamsListPendingInvitationsInOrgEndpoint

TeamsListPendingInvitationsInOrgEndpoint: { org: string; page?: number; per_page?: number; team_slug: string }

Type declaration

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • team_slug: string

    team_slug parameter

TeamsListPendingInvitationsInOrgRequestOptions

TeamsListPendingInvitationsInOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsListPendingInvitationsLegacyEndpoint

TeamsListPendingInvitationsLegacyEndpoint: { page?: number; per_page?: number; team_id: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • team_id: number

    team_id parameter

TeamsListPendingInvitationsLegacyRequestOptions

TeamsListPendingInvitationsLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsListPendingInvitationsRequestOptions

TeamsListPendingInvitationsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsListProjectsEndpoint

TeamsListProjectsEndpoint: { page?: number; per_page?: number; team_id: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • team_id: number

    team_id parameter

TeamsListProjectsInOrgEndpoint

TeamsListProjectsInOrgEndpoint: { org: string; page?: number; per_page?: number; team_slug: string }

Type declaration

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • team_slug: string

    team_slug parameter

TeamsListProjectsInOrgRequestOptions

TeamsListProjectsInOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsListProjectsLegacyEndpoint

TeamsListProjectsLegacyEndpoint: { page?: number; per_page?: number; team_id: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • team_id: number

    team_id parameter

TeamsListProjectsLegacyRequestOptions

TeamsListProjectsLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsListProjectsRequestOptions

TeamsListProjectsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsListReposEndpoint

TeamsListReposEndpoint: { page?: number; per_page?: number; team_id: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • team_id: number

    team_id parameter

TeamsListReposInOrgEndpoint

TeamsListReposInOrgEndpoint: { org: string; page?: number; per_page?: number; team_slug: string }

Type declaration

  • org: string

    org parameter

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • team_slug: string

    team_slug parameter

TeamsListReposInOrgRequestOptions

TeamsListReposInOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsListReposLegacyEndpoint

TeamsListReposLegacyEndpoint: { page?: number; per_page?: number; team_id: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • team_id: number

    team_id parameter

TeamsListReposLegacyRequestOptions

TeamsListReposLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsListReposRequestOptions

TeamsListReposRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsListRequestOptions

TeamsListRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsRemoveMemberEndpoint

TeamsRemoveMemberEndpoint: { team_id: number; username: string }

Type declaration

  • team_id: number

    team_id parameter

  • username: string

    username parameter

TeamsRemoveMemberLegacyEndpoint

TeamsRemoveMemberLegacyEndpoint: { team_id: number; username: string }

Type declaration

  • team_id: number

    team_id parameter

  • username: string

    username parameter

TeamsRemoveMemberLegacyRequestOptions

TeamsRemoveMemberLegacyRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsRemoveMemberRequestOptions

TeamsRemoveMemberRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsRemoveMembershipEndpoint

TeamsRemoveMembershipEndpoint: { team_id: number; username: string }

Type declaration

  • team_id: number

    team_id parameter

  • username: string

    username parameter

TeamsRemoveMembershipInOrgEndpoint

TeamsRemoveMembershipInOrgEndpoint: { org: string; team_slug: string; username: string }

Type declaration

  • org: string

    org parameter

  • team_slug: string

    team_slug parameter

  • username: string

    username parameter

TeamsRemoveMembershipInOrgRequestOptions

TeamsRemoveMembershipInOrgRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsRemoveMembershipLegacyEndpoint

TeamsRemoveMembershipLegacyEndpoint: { team_id: number; username: string }

Type declaration

  • team_id: number

    team_id parameter

  • username: string

    username parameter

TeamsRemoveMembershipLegacyRequestOptions

TeamsRemoveMembershipLegacyRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsRemoveMembershipRequestOptions

TeamsRemoveMembershipRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsRemoveProjectEndpoint

TeamsRemoveProjectEndpoint: { project_id: number; team_id: number }

Type declaration

  • project_id: number

    project_id parameter

  • team_id: number

    team_id parameter

TeamsRemoveProjectInOrgEndpoint

TeamsRemoveProjectInOrgEndpoint: { org: string; project_id: number; team_slug: string }

Type declaration

  • org: string

    org parameter

  • project_id: number

    project_id parameter

  • team_slug: string

    team_slug parameter

TeamsRemoveProjectInOrgRequestOptions

TeamsRemoveProjectInOrgRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsRemoveProjectLegacyEndpoint

TeamsRemoveProjectLegacyEndpoint: { project_id: number; team_id: number }

Type declaration

  • project_id: number

    project_id parameter

  • team_id: number

    team_id parameter

TeamsRemoveProjectLegacyRequestOptions

TeamsRemoveProjectLegacyRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsRemoveProjectRequestOptions

TeamsRemoveProjectRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsRemoveRepoEndpoint

TeamsRemoveRepoEndpoint: { owner: string; repo: string; team_id: number }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • team_id: number

    team_id parameter

TeamsRemoveRepoInOrgEndpoint

TeamsRemoveRepoInOrgEndpoint: { org: string; owner: string; repo: string; team_slug: string }

Type declaration

  • org: string

    org parameter

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • team_slug: string

    team_slug parameter

TeamsRemoveRepoInOrgRequestOptions

TeamsRemoveRepoInOrgRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsRemoveRepoLegacyEndpoint

TeamsRemoveRepoLegacyEndpoint: { owner: string; repo: string; team_id: number }

Type declaration

  • owner: string

    owner parameter

  • repo: string

    repo parameter

  • team_id: number

    team_id parameter

TeamsRemoveRepoLegacyRequestOptions

TeamsRemoveRepoLegacyRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsRemoveRepoRequestOptions

TeamsRemoveRepoRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsReviewProjectEndpoint

TeamsReviewProjectEndpoint: { project_id: number; team_id: number }

Type declaration

  • project_id: number

    project_id parameter

  • team_id: number

    team_id parameter

TeamsReviewProjectInOrgEndpoint

TeamsReviewProjectInOrgEndpoint: { org: string; project_id: number; team_slug: string }

Type declaration

  • org: string

    org parameter

  • project_id: number

    project_id parameter

  • team_slug: string

    team_slug parameter

TeamsReviewProjectInOrgRequestOptions

TeamsReviewProjectInOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsReviewProjectLegacyEndpoint

TeamsReviewProjectLegacyEndpoint: { project_id: number; team_id: number }

Type declaration

  • project_id: number

    project_id parameter

  • team_id: number

    team_id parameter

TeamsReviewProjectLegacyRequestOptions

TeamsReviewProjectLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsReviewProjectRequestOptions

TeamsReviewProjectRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsUpdateDiscussionCommentEndpoint

TeamsUpdateDiscussionCommentEndpoint: { body: string; comment_number: number; discussion_number: number; team_id: number }

Type declaration

  • body: string

    The discussion comment's body text.

  • comment_number: number

    comment_number parameter

  • discussion_number: number

    discussion_number parameter

  • team_id: number

    team_id parameter

TeamsUpdateDiscussionCommentInOrgEndpoint

TeamsUpdateDiscussionCommentInOrgEndpoint: { body: string; comment_number: number; discussion_number: number; org: string; team_slug: string }

Type declaration

  • body: string

    The discussion comment's body text.

  • comment_number: number

    comment_number parameter

  • discussion_number: number

    discussion_number parameter

  • org: string

    org parameter

  • team_slug: string

    team_slug parameter

TeamsUpdateDiscussionCommentInOrgRequestOptions

TeamsUpdateDiscussionCommentInOrgRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsUpdateDiscussionCommentLegacyEndpoint

TeamsUpdateDiscussionCommentLegacyEndpoint: { body: string; comment_number: number; discussion_number: number; team_id: number }

Type declaration

  • body: string

    The discussion comment's body text.

  • comment_number: number

    comment_number parameter

  • discussion_number: number

    discussion_number parameter

  • team_id: number

    team_id parameter

TeamsUpdateDiscussionCommentLegacyRequestOptions

TeamsUpdateDiscussionCommentLegacyRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsUpdateDiscussionCommentRequestOptions

TeamsUpdateDiscussionCommentRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsUpdateDiscussionEndpoint

TeamsUpdateDiscussionEndpoint: { body?: string; discussion_number: number; team_id: number; title?: string }

Type declaration

  • Optional body?: string

    The discussion post's body text.

  • discussion_number: number

    discussion_number parameter

  • team_id: number

    team_id parameter

  • Optional title?: string

    The discussion post's title.

TeamsUpdateDiscussionInOrgEndpoint

TeamsUpdateDiscussionInOrgEndpoint: { body?: string; discussion_number: number; org: string; team_slug: string; title?: string }

Type declaration

  • Optional body?: string

    The discussion post's body text.

  • discussion_number: number

    discussion_number parameter

  • org: string

    org parameter

  • team_slug: string

    team_slug parameter

  • Optional title?: string

    The discussion post's title.

TeamsUpdateDiscussionInOrgRequestOptions

TeamsUpdateDiscussionInOrgRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsUpdateDiscussionLegacyEndpoint

TeamsUpdateDiscussionLegacyEndpoint: { body?: string; discussion_number: number; team_id: number; title?: string }

Type declaration

  • Optional body?: string

    The discussion post's body text.

  • discussion_number: number

    discussion_number parameter

  • team_id: number

    team_id parameter

  • Optional title?: string

    The discussion post's title.

TeamsUpdateDiscussionLegacyRequestOptions

TeamsUpdateDiscussionLegacyRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsUpdateDiscussionRequestOptions

TeamsUpdateDiscussionRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsUpdateEndpoint

TeamsUpdateEndpoint: { description?: string; name: string; parent_team_id?: number; permission?: "pull" | "push" | "admin"; privacy?: "secret" | "closed"; team_id: number }

Type declaration

  • Optional description?: string

    The description of the team.

  • name: string

    The name of the team.

  • Optional parent_team_id?: number

    The ID of a team to set as the parent team.

  • Optional permission?: "pull" | "push" | "admin"

    Deprecated. The permission that new repositories will be added to the team with when none is specified. Can be one of: * pull - team members can pull, but not push to or administer newly-added repositories. * push - team members can pull and push, but not administer newly-added repositories. * admin - team members can pull, push and administer newly-added repositories.

  • Optional privacy?: "secret" | "closed"

    The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. The options are: For a non-nested team: * secret - only visible to organization owners and members of this team. * closed - visible to all members of this organization. For a parent or child team: * closed - visible to all members of this organization.

  • team_id: number

    team_id parameter

TeamsUpdateInOrgEndpoint

TeamsUpdateInOrgEndpoint: { description?: string; name: string; org: string; parent_team_id?: number; permission?: "pull" | "push" | "admin"; privacy?: "secret" | "closed"; team_slug: string }

Type declaration

  • Optional description?: string

    The description of the team.

  • name: string

    The name of the team.

  • org: string

    org parameter

  • Optional parent_team_id?: number

    The ID of a team to set as the parent team.

  • Optional permission?: "pull" | "push" | "admin"

    Deprecated. The permission that new repositories will be added to the team with when none is specified. Can be one of: * pull - team members can pull, but not push to or administer newly-added repositories. * push - team members can pull and push, but not administer newly-added repositories. * admin - team members can pull, push and administer newly-added repositories.

  • Optional privacy?: "secret" | "closed"

    The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. When a team is nested, the privacy for parent teams cannot be secret. The options are: For a non-nested team: * secret - only visible to organization owners and members of this team. * closed - visible to all members of this organization. For a parent or child team: * closed - visible to all members of this organization.

  • team_slug: string

    team_slug parameter

TeamsUpdateInOrgRequestOptions

TeamsUpdateInOrgRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsUpdateLegacyEndpoint

TeamsUpdateLegacyEndpoint: { description?: string; name: string; parent_team_id?: number; permission?: "pull" | "push" | "admin"; privacy?: "secret" | "closed"; team_id: number }

Type declaration

  • Optional description?: string

    The description of the team.

  • name: string

    The name of the team.

  • Optional parent_team_id?: number

    The ID of a team to set as the parent team.

  • Optional permission?: "pull" | "push" | "admin"

    Deprecated. The permission that new repositories will be added to the team with when none is specified. Can be one of: * pull - team members can pull, but not push to or administer newly-added repositories. * push - team members can pull and push, but not administer newly-added repositories. * admin - team members can pull, push and administer newly-added repositories.

  • Optional privacy?: "secret" | "closed"

    The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. The options are: For a non-nested team: * secret - only visible to organization owners and members of this team. * closed - visible to all members of this organization. For a parent or child team: * closed - visible to all members of this organization.

  • team_id: number

    team_id parameter

TeamsUpdateLegacyRequestOptions

TeamsUpdateLegacyRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

TeamsUpdateRequestOptions

TeamsUpdateRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

UsersAddEmailsEndpoint

UsersAddEmailsEndpoint: { emails: string[] }

Type declaration

  • emails: string[]

    Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

UsersAddEmailsRequestOptions

UsersAddEmailsRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

UsersBlockEndpoint

UsersBlockEndpoint: { username: string }

Type declaration

  • username: string

    username parameter

UsersBlockRequestOptions

UsersBlockRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

UsersCheckBlockedEndpoint

UsersCheckBlockedEndpoint: { username: string }

Type declaration

  • username: string

    username parameter

UsersCheckBlockedRequestOptions

UsersCheckBlockedRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

UsersCheckFollowingEndpoint

UsersCheckFollowingEndpoint: { username: string }

Type declaration

  • username: string

    username parameter

UsersCheckFollowingForUserEndpoint

UsersCheckFollowingForUserEndpoint: { target_user: string; username: string }

Type declaration

  • target_user: string

    target_user parameter

  • username: string

    username parameter

UsersCheckFollowingForUserRequestOptions

UsersCheckFollowingForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

UsersCheckFollowingRequestOptions

UsersCheckFollowingRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

UsersCreateGpgKeyEndpoint

UsersCreateGpgKeyEndpoint: { armored_public_key?: string }

Type declaration

  • Optional armored_public_key?: string

    Your GPG key, generated in ASCII-armored format. See "Generating a new GPG key" for help creating a GPG key.

UsersCreateGpgKeyRequestOptions

UsersCreateGpgKeyRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

UsersCreatePublicKeyEndpoint

UsersCreatePublicKeyEndpoint: { key?: string; title?: string }

Type declaration

  • Optional key?: string

    The public SSH key to add to your GitHub account. See "Generating a new SSH key" for guidance on how to create a public SSH key.

  • Optional title?: string

    A descriptive name for the new key. Use a name that will help you recognize this key in your GitHub account. For example, if you're using a personal Mac, you might call this key "Personal MacBook Air".

UsersCreatePublicKeyRequestOptions

UsersCreatePublicKeyRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: Url }

Type declaration

UsersDeleteEmailsEndpoint

UsersDeleteEmailsEndpoint: { emails: string[] }

Type declaration

  • emails: string[]

    Deletes one or more email addresses from your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

UsersDeleteEmailsRequestOptions

UsersDeleteEmailsRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

UsersDeleteGpgKeyEndpoint

UsersDeleteGpgKeyEndpoint: { gpg_key_id: number }

Type declaration

  • gpg_key_id: number

    gpg_key_id parameter

UsersDeleteGpgKeyRequestOptions

UsersDeleteGpgKeyRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

UsersDeletePublicKeyEndpoint

UsersDeletePublicKeyEndpoint: { key_id: number }

Type declaration

  • key_id: number

    key_id parameter

UsersDeletePublicKeyRequestOptions

UsersDeletePublicKeyRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

UsersFollowEndpoint

UsersFollowEndpoint: { username: string }

Type declaration

  • username: string

    username parameter

UsersFollowRequestOptions

UsersFollowRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: Url }

Type declaration

UsersGetAuthenticatedEndpoint

UsersGetAuthenticatedEndpoint: {}

Type declaration

UsersGetAuthenticatedRequestOptions

UsersGetAuthenticatedRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

UsersGetByUsernameEndpoint

UsersGetByUsernameEndpoint: { username: string }

Type declaration

  • username: string

    username parameter

UsersGetByUsernameRequestOptions

UsersGetByUsernameRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

UsersGetContextForUserEndpoint

UsersGetContextForUserEndpoint: { subject_id?: string; subject_type?: "organization" | "repository" | "issue" | "pull_request"; username: string }

Type declaration

  • Optional subject_id?: string

    Uses the ID for the subject_type you specified. Required when using subject_type.

  • Optional subject_type?: "organization" | "repository" | "issue" | "pull_request"

    Identifies which additional information you'd like to receive about the person's hovercard. Can be organization, repository, issue, pull_request. Required when using subject_id.

  • username: string

    username parameter

UsersGetContextForUserRequestOptions

UsersGetContextForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

UsersGetGpgKeyEndpoint

UsersGetGpgKeyEndpoint: { gpg_key_id: number }

Type declaration

  • gpg_key_id: number

    gpg_key_id parameter

UsersGetGpgKeyRequestOptions

UsersGetGpgKeyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

UsersGetPublicKeyEndpoint

UsersGetPublicKeyEndpoint: { key_id: number }

Type declaration

  • key_id: number

    key_id parameter

UsersGetPublicKeyRequestOptions

UsersGetPublicKeyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

UsersListBlockedEndpoint

UsersListBlockedEndpoint: {}

Type declaration

UsersListBlockedRequestOptions

UsersListBlockedRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

UsersListEmailsEndpoint

UsersListEmailsEndpoint: { page?: number; per_page?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

UsersListEmailsRequestOptions

UsersListEmailsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

UsersListEndpoint

UsersListEndpoint: { page?: number; per_page?: number; since?: string }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • Optional since?: string

    The integer ID of the last User that you've seen.

UsersListFollowedByAuthenticatedEndpoint

UsersListFollowedByAuthenticatedEndpoint: { page?: number; per_page?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

UsersListFollowedByAuthenticatedRequestOptions

UsersListFollowedByAuthenticatedRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

UsersListFollowersForAuthenticatedUserEndpoint

UsersListFollowersForAuthenticatedUserEndpoint: { page?: number; per_page?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

UsersListFollowersForAuthenticatedUserRequestOptions

UsersListFollowersForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

UsersListFollowersForUserEndpoint

UsersListFollowersForUserEndpoint: { page?: number; per_page?: number; username: string }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • username: string

    username parameter

UsersListFollowersForUserRequestOptions

UsersListFollowersForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

UsersListFollowingForAuthenticatedUserEndpoint

UsersListFollowingForAuthenticatedUserEndpoint: { page?: number; per_page?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

UsersListFollowingForAuthenticatedUserRequestOptions

UsersListFollowingForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

UsersListFollowingForUserEndpoint

UsersListFollowingForUserEndpoint: { page?: number; per_page?: number; username: string }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • username: string

    username parameter

UsersListFollowingForUserRequestOptions

UsersListFollowingForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

UsersListGpgKeysEndpoint

UsersListGpgKeysEndpoint: { page?: number; per_page?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

UsersListGpgKeysForUserEndpoint

UsersListGpgKeysForUserEndpoint: { page?: number; per_page?: number; username: string }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • username: string

    username parameter

UsersListGpgKeysForUserRequestOptions

UsersListGpgKeysForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

UsersListGpgKeysRequestOptions

UsersListGpgKeysRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

UsersListPublicEmailsEndpoint

UsersListPublicEmailsEndpoint: { page?: number; per_page?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

UsersListPublicEmailsRequestOptions

UsersListPublicEmailsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

UsersListPublicKeysEndpoint

UsersListPublicKeysEndpoint: { page?: number; per_page?: number }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

UsersListPublicKeysForUserEndpoint

UsersListPublicKeysForUserEndpoint: { page?: number; per_page?: number; username: string }

Type declaration

  • Optional page?: number

    Page number of the results to fetch.

  • Optional per_page?: number

    Results per page (max 100)

  • username: string

    username parameter

UsersListPublicKeysForUserRequestOptions

UsersListPublicKeysForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

UsersListPublicKeysRequestOptions

UsersListPublicKeysRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

UsersListRequestOptions

UsersListRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: Url }

Type declaration

UsersTogglePrimaryEmailVisibilityEndpoint

UsersTogglePrimaryEmailVisibilityEndpoint: { email: string; visibility: string }

Type declaration

  • email: string

    Specify the primary email address that needs a visibility change.

  • visibility: string

    Use public to enable an authenticated user to view the specified email address, or use private so this primary email address cannot be seen publicly.

UsersTogglePrimaryEmailVisibilityRequestOptions

UsersTogglePrimaryEmailVisibilityRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

UsersUnblockEndpoint

UsersUnblockEndpoint: { username: string }

Type declaration

  • username: string

    username parameter

UsersUnblockRequestOptions

UsersUnblockRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

UsersUnfollowEndpoint

UsersUnfollowEndpoint: { username: string }

Type declaration

  • username: string

    username parameter

UsersUnfollowRequestOptions

UsersUnfollowRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: Url }

Type declaration

UsersUpdateAuthenticatedEndpoint

UsersUpdateAuthenticatedEndpoint: { bio?: string; blog?: string; company?: string; email?: string; hireable?: boolean; location?: string; name?: string }

Type declaration

  • Optional bio?: string

    The new short biography of the user.

  • Optional blog?: string

    The new blog URL of the user.

  • Optional company?: string

    The new company of the user.

  • Optional email?: string

    The publicly visible email address of the user.

  • Optional hireable?: boolean

    The new hiring availability of the user.

  • Optional location?: string

    The new location of the user.

  • Optional name?: string

    The new name of the user.

UsersUpdateAuthenticatedRequestOptions

UsersUpdateAuthenticatedRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: Url }

Type declaration

Generated using TypeDoc